Karen Cwalinski Advanced Roll-Up (Spreadsheet)-10-template Karen Cwalinski 2 100 2007-01-30T13:13:00Z 2007-01-30T13:13:00Z 2 20909 119186 CorasWorks Corp 993 279 139816 11.8107 false false false C:\Documents and Settings\KCwalinski\Desktop\Interim W07 Help\CorasWorks Web Parts Help.d2h

Advanced Roll-Up (Spreadsheet)

Overview XE "Overview:Spreadsheet Roll-Up"  XE "Spreadsheet Roll-Up:Overview"

 

CorasWorks Spreadsheet Advanced Roll-Up™ web parts roll up items from selected lists that meet the qualifications for display, and display them in a single spreadsheet-style view that can be ordered by column.  This type of display is useful for large groups of related data, and the results can be exported to Microsoft Excel.  You can also control the number of items to show in a list and use Next and Back buttons.

 

Last Modified:   DATE \@ "MMMM yy" January 07

Admin: Sites and Lists Tab XE "Sites and Lists Tab:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Administration Window (Pre-Summer 2005 Only)” instead.

As of the Summer 05 release, the administration interface includes a Sites and Lists tab that is used to select the sites, portals, and/or sub-areas and lists to include in the user presentation of the roll-up. You can select any number of lists or libraries from any number of sites on the server that the web part is running on as the source for the roll-up.

When you are finished making your selections on this tab, make sure you click Apply to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display. Other tabs do not require you to click Apply to save changes; changes are saved automatically when you move from one tab to another. However, this tab differs in that clicking Apply loads your schema selections and other settings referenced by other tabs.

Return Type XE "Return Type:Spreadsheet Roll-Up"  XE "Selective Return Type:Spreadsheet Roll-Up"  XE "Line of Site Return Type:Spreadsheet Roll-Up"

This field is used to specify how the web part should identify the sites and lists to include in the roll-up display.

·      Selective allows you to select each specific list that you want to include.

·      Line of Site enables you to identify a URL and the number of levels below that URL to include in the display. Any sites that exist now or are created in the future within the specified number of levels will be automatically recognized and included in the roll-up display. If you choose Line of Site, the page refreshes and the "List Selection Settings" section is removed from the display.

Did you know… With Selective roll-ups, you can reference a list to which your users have read access in a site to which they do not have access. This is because Selective roll-ups hard-code the URL of the site and list, and do not check to see if the user has access to the entire site, as Line of Site roll-ups do.

Site URL XE "Site URL:Spreadsheet Roll-Up"

This optional field is used to define the URL for the site (or the top-level site) you want to access and from which you want to return list items. This can be any SharePoint site that resides on the same server as this web part. If this field is left blank, it will default to the URL where the roll-up web part is placed.

The format for the URL is http://Site-URL/SiteName.

Examples:

·      http://www.sitename.com/

·      http://www.sitename.com/site1

·      http://www.sitename.com/site1/site1a

To include lists from more than one site, type the first URL you want to work with in the Site URL field and then click Add URL. The URL you just identified is placed in the box below the field. Type another URL in the Site URL field and click Add URL again. Repeat this process as many times as necessary.

To remove selected URLs from this area, highlight the URL you want to remove from the box below this field and click Remove. Alternatively, you can click Remove All to remove all URLs.

TIP 1: If the site that contains the lists you want to work with is displayed by the Workplace View Advanced web part, you can right-click on the site, select Copy Shortcut, and paste the URL in the Site URL field.

TIP 2: If you configure a roll-up as Line of Site and a user does not have rights to access a particular site, that site and any sites under that site will not be included in the roll-up. This is true even if the user does have rights to a site that’s below the site to which they do not have access. If you want the roll-up to include the site to which the user does have rights, you can take advantage of the ability to identify multiple URLs in the Site URL field and include the URL of the site to which they do have access.

Schemas XE "Schema Selection:Spreadsheet Roll-Up"

This drop-down field lists all of the available schemas that can be used with this web part. The default is “Utilize All Schemas.” However, you can choose to include only those lists that utilize a particular schema. This can be useful if you want to narrow your search to those list templates that include the fields that you want to use.

Schemas contain the elements that identify a list: the list type, filter and search fields, display fields, and so on. When you select a schema, the elements of that schema will be used to find only those lists that match that schema profile. Lists of schemas can be found in the Supported Schemas section of this web part help.

NOTE: If you have created your own schemas, you will not be able to select them from the Schemas drop-down for the out-of-the-box CorasWorks Spreadsheet roll-ups. You will need to create your own version of the roll-up web part that references your custom schema using the Roll-Up Wizard, which is available with the Developer and Small Business editions of the Workplace Suite.

Site Levels Searched  XE "Site Levels:Spreadsheet Roll-Up"

This optional field is used to define the number of levels to search within a site to find lists for the roll-up display. If this field is left blank, it will default to 0, which searches only the site named in the Site URL field. The maximum recommended number of levels is 10.

Please make sure that a number is entered in this field. If you spell out a number, it will result in an error and no lists will be found.

If you have chosen the Selective return type and you change the value identified in this field, click the “Refresh Available Lists” option to the right of this field.  This updates the sites and lists identified in the Available Lists drop-down field, described below.

Available Lists (Selective Only)  XE "Available Lists:Spreadsheet Roll-Up"

This drop-down field displays the lists available to be chosen for return by the web part. This includes all available lists, even if they have already been selected and are displayed in the "Currently Selected Lists" field. The format for the lists displayed here is “Site Name | List Name.”

Click on a list to add it to your selection for the web part display. Click "Select All Sites & Lists" to include items from all of the available lists in the web part display.

Currently Selected Lists (Selective Only)

This area displays all of the lists you have selected to include in the roll-up display. The format for the lists displayed in this field is “Site Name | List Name.”

To remove a list, simply highlight the list and it will be removed from the display. Select "Remove All Sites & Lists" to remove all of the lists from the roll-up display.

 

When you are finished making your selections on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

 

Back to Top

Admin: Filtering Tab XE "Filtering Tab:Spreadsheet Roll-Up"  XE "Filtering:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Web Part Properties (Pre-Summer 2005 Only)” instead.

Filtering allows you to limit the items returned by a roll-up to only those that meet the criteria you define.  When a filter is performed, the roll-up looks for text matches on the metadata returned by the roll-up.  Users can further refine the results by performing searches on a filtered roll-up. Note that filtering allows you to locate data in a specific field, while searching locates data in any field in the list.

There are two available views on the Filtering tab:

·      The default view is referenced as the “Filter Builder.”  It provides a series of builder fields that make it easier for non-technical individuals to define filters because it is not necessary to know the correct syntax; the fields prompt you for each necessary piece of information.

·      The other view is referenced as “Advanced Filter Settings” and it allows you to manually build a tab. You can use the Basic Filter field to define a filter, or you can use the CAML Filter field to define a filter that utilizes CAML. Click here to jump down to that section of the help.

This topic includes the following subjects:

·      Defining a Filter with the Filter Builder

·      Manually Defining a Filter

·      Tips on Defining Filters

·      Conversion to CAML

·      Upgrading from Previous Versions

NOTE 1: To gain the best performance for filters, use the Filter Builder to build your filters; do not use complex, basic, or the feature to automatically convert basic filters to CAML.  If a basic filter was used in a previous release and you want to have it permanently converted to CAML, simply open the Filter Builder and click Apply or OK.  This converts the basic filter to CAML, loads the filter into the Filter Builder, and then saves the new CAML filter and deletes the old basic filter.

NOTE 2: If you want the roll-up to include documents in multiple levels of folders, you will need to manually define a basic filter. This is because Spreadsheet roll-ups do not include any items in folders when a CAML-based filter is utilized (defined either manually or using the Filter Builder).

 

Defining a Filter with the Filter Builder XE "Filter Builder:Spreadsheet Roll-Up"

When you first access the Filtering tab, the Filter Builder is displayed.  Each component of the filter is comprised of three fields:

·      The first field presents a drop-down list of all of the fields that are available for filtering.  Click to select the field you want to start building your filter with.

·      The next field is used to select the desired operator for the filter (is equal to, is less than, contains, etc.).

·      The third field is used to identify the value you want the filter to find.  You can simply type in the value you want to find, or you can use a function (see “Supported Functions” below).

If you only want to filter on a single field and a single value, all you need to do is click Apply or OK to save your filter.  When your filter is saved, it will be converted to CAML automatically. This is done to help improve performance.

NOTE: Do not enter any CAML code in the Filter Builder.  The Builder will automatically convert the criteria to CAML for you. If you have criteria that is too complex to enter in the Filter Builder, use the Click to manually build a filter” link at the bottom of the tab and define the filter in the CAML Filter field.

The following values can be entered into the third entry field for filters based on Boolean fields:

·      True

·      False

·      Yes

·      No

·      0 (translates to False)

·      1 (translates to True)

To filter on multiple fields and/or values, you need to define additional filter components. The Filtering tab presents two groups of criteria that can be used:

·      The group of fields on the top half of the tab are used to define the “and” components of the filter. The roll-up will only display items that meet all of the criteria entered here. (For example, Status is equal to In Progress AND Priority is equal to High.)

·      The group of fields on the lower half of this tab allow you to define the “or” components of the filter. The roll-up will display items that meet any (one or more) of the criteria entered here. (For example, Status is equal to Not Started OR Status is equal to On Hold.)

To define multiple filter components on either the top or bottom half of the tab, click the “Add More Filter Criteria” link in the appropriate section. This adds another set of three builder fields so you can define additional criteria.

NOTE: The Filter Builder works as expected with one, two, or any even number of clauses. However, it needs help with three, five, or any other odd number of clauses. In these cases, the filter must be balanced. Rather than having an odd number of clauses, you will need to add a “dummy” query to create an even number. The dummy query can be an "is not Null" check and exists only to even out the query to be built by the Filter Builder.

The drop-down field in the middle of the tab (below the line) presents two options, Or and And.  If you have defined components on both halves of the tab, select the appropriate option for your needs.

·      Select “Or” if you want the filter to locate items that meet the criteria on the top half of the tab or any of the criteria on the lower half

·      Select “And” if you want the filter to locate items that meet the criteria on the top half of the tab plus at least one of the criteria on the lower half

NOTE: The Filter Builder cannot be used to build the equivalent of this expression:

(A AND B) OR (C AND D)

If you want to create this type of filter, the filter will need to be defined manually.

 

Supported Functions XE "Filter Functions:Spreadsheet Roll-Up"  XE "Functions (Filter):Spreadsheet Roll-Up"

The Filter Builder supports the functions listed below. The date functions are all relative to the current date, and can only be used if the filter is defined based on a date field.

·      [ME] – The currently logged in user

·      [Today] – Today's date

·      [CurrentWeekStart] – The first day in the current week

·      [CurrentWeekEnd] – The last day in the current week

·      [CurrentMonthStart] – The first day in the current month

·      [CurrentMonthEnd] – The last day in the current month

·      [CurrentYearStart] – The first day in the current year

·      [CurrentYearEnd] – The last day in the current year

·      [Quarter1Start] – The first day in the first quarter of the current year

·      [Quarter1End] – The last day in the first quarter of the current year

·      [Quarter2Start] – The first day in the second quarter of the current year

·      [Quarter2End] – The last day in the second quarter of the current year

·      [Quarter3Start] – The first day in the third quarter of the current year

·      [Quarter3End] – The last day in the third quarter of the current year

·      [Quarter4Start] – The first day in the fourth quarter of the current year

·      [Quarter4End] – The last day in the fourth quarter of the current year

·      [OneWeekAgoStart] – The first day of the previous week

·      [OneWeekAgoEnd] – The last day of the previous week

·      [TwoWeeksAgoStart] – The first day of the week before last

·      [TwoWeeksAgoEnd] – The last day of the week before last

·      [OneWeekFromNowStart] – The first day of next week

·      [OneWeekFromNowEnd] – The last day of next week

·      [TwoWeeksFromNowStart] – The first day of the week after next

·      [TwoWeeksFromNowEnd] – The last day of the week after next

·      [OneMonthAgoStart] – The first day of last month

·      [OneMonthAgoEnd] – The last day of last month

·      [OneMonthFromNowStart] – The first day of next month

·      [OneMonthFromNowEnd] – The last day of next month

NOTE: The filter functions [SiteTitle] and [SiteURL] functions are no longer supported.

Sample Filters

To help you see how filters can be set up, a few sample screen captures are provided here.

Example 1

In this example from the Partner Extranet Dashboard, a filter is defined to locate leads that have been created within the past 30 days.

 

Example 2

This example is taken from the Picture Phone Book solution. It looks for contact items where the last name starts with A, B, C, or D.

 

Example 3

In this example, a filter is defined to look for all items that are due in the third quarter of this year AND EITHER:

·      High priority OR

·      Not started

 

Back to Top

Manually Defining a Filter XE "Manual Filter Definition:Spreadsheet Roll-Up"

To access the fields used to manually build a filter, click the “Click to manually build a filter” link at the bottom of the Filter Builder on the Filtering tab. Two main fields are displayed, one where you can build a basic filter and one where you can build a CAML filter. Another link at the bottom of this view allows you to return to the Filter Builder view.

The format for a basic filter (placed in the Basic Filter field) is "Field=SearchText" (Example: Postal Code=11111). You can use > and < when filtering date fields.  (Example: "Date<7" will return items that are older than 7 days from today)  Filter grouping with parentheses () is not permitted.  The fields available to use for filtering are identified in the Supported Schemas section of this help, on the “Filterable Fields” line of each identified schema.

The following values can be used for filters based on Boolean fields:

·      True

·      False

·      Yes

·      No

·      0 (translates to False)

·      1 (translates to True)

Some common examples of filters and connectors are shown here:

Example 1: Show all tasks that are assigned to me, and are due within seven days
Assigned To=[ME] && Due Date>-1 && Due Date<7

Example 2: Show all tasks that are assigned to me or to someone else
Assigned To=[ME] || Assigned To=UserName

Example 3: Show all tasks that are not assigned to me
Assigned To<>[ME]

Where:

·      && = And

·      || = Or

·      <> = Not

·      [ME] = Currently Logged In User

 

NOTE 1: The majority of the date functions available with the Filter Builder only work with CAML filters. They will not work if you manually build a filter in the Basic Filter field. The date functions that will work with CAML, basic, or complex filters are:

·      [Today]

·      [CurrentWeekStart]

·      [CurrentWeekEnd]

·      [CurrentMonthStart]

·      [CurrentMonthEnd]

·      [CurrentYearStart]

·      [CurrentYearEnd]

NOTE 2: If you define a basic filter in the Basic Filter field and then use the Filter Builder to modify it later, when you click OK, Apply, or another tab, the filter is saved as CAML and the Basic Filter field is cleared.

NOTE 3: If you define a CAML filter on this page, you cannot return to the Filter Builder unless you delete the CAML filter. This is by design.

 

For more information on filters, visit this site: http://office.microsoft.com/en-us/assistance/HA011611751033.aspx.

Back to Top

 

Tips on Defining Filters XE "Filtering:Tips:Spreadsheet Roll-Up"

These tips apply whether you choose to use the Filter Builder or manually define a filter.

Available Columns for Filter Definition

Columns do not have to be displayed in order to be referenced in a filter, but they do need to be searchable.  Only searchable columns will be listed in the drop-down field in the Filter Builder. To make a column searchable, the Search box must selected when the roll-up is created or modified via the Roll-Up Wizard. By default, all columns that are selected in the Roll-Up Wizard for display are also marked as searchable.

Contains vs. Is Equal To or =

Because SharePoint sometimes stores data differently than the way it is displayed, you may find that you get better results from your filters when you use the "Contains" operator instead of "Is Equal To" or “=”.

For example, you may see the name "Bob Smith" in a list item that includes the Assigned To field. However, SharePoint stores this name with extra characters, so the actual stored value may be something like "3;#Bob Smith." Therefore, if you want to filter on records that were assigned to Bob, you get the desired results if you build the filter with the "Contains" operator.

Using Yes/No Columns vs. Choice Columns with Yes/No Options

It is important to understand the difference between Yes/No columns and Choice columns with Yes and No options.

When you use a Yes/No column, SharePoint stores a “True” value when the field is selected and leaves it blank when it is not selected. As a result, if you want to filter on a Yes/No column, you need to set the filter to look for the appropriate value:

·      To filter on a selected (Yes) value, the filter would be
column is equal to True (using the Filter Builder) OR
column=True (manually defining the filter)
(replace “column” with the name of your column)

·      To filter on a non-selected (No) value, the filter would be
column is not equal to True (using the Filter Builder) OR
column<>True (manually defining the filter)

When you use a Choice column with Yes and No options, the filter should be defined as:
column is equal to value (using the Filter Builder) OR
column=value (manually defining the filter)

Balancing Your Filters

The Filter Builder works as expected with one, two, or any even number of clauses. However, it needs help with three, five, or any other odd number of clauses. In these cases, the filter must be balanced. Rather than having an odd number of clauses, you will need to add a “dummy” query to create an even number. The dummy query can be an "is not Null" check and exists only to even out the query to be built by the Filter Builder.

When You DON’T Want to Use the Filter Builder XE "Folders:Effect on Filtering:Spreadsheet"  XE "Filter Builder:When not to use"

The Filter Builder cannot be used to build the equivalent of this expression:

(A AND B) OR (C AND D)

If you want to create this type of filter, the filter will need to be defined manually.

Also…

You will need to manually define a basic filter if you want the roll-up to include documents in multiple levels of folders. This is because Spreadsheet roll-ups do not include any items in folders when a CAML-based filter is utilized (defined either manually or using the Filter Builder).

 

Back to Top

 

Conversion to CAML XE "CAML:Spreadsheet Roll-Up"  XE "Filters and CAML:Spreadsheet Roll-Up"  XE "Conversion to CAML-Filters:Spreadsheet Roll-Up"

As of the Summer 2005 release, any filters applied to CorasWorks roll-ups are automatically converted to Collaborative Application Markup Language (CAML).  The Filter Builder only builds CAML filters.

This is the case for all filters built using the Filter Builder, and it is the default treatment for filters that are defined manually.  There is a checkbox below the Basic Filter field that allows you to turn this option off, but the default is for this option to be selected (enabled).  If you do not see the checkbox, click the “Click to manually build a filter” link at the bottom of the tab.

Filters built using the Filter Builder are converted to CAML when they are saved.  Filters that are built manually are converted to CAML at run-time, with these exceptions:

·      When the basic filter includes an apostrophe (‘)

·      When both a basic filter and a CAML filter have been specified

·      When a basic filter is entered and the Convert basic filter to advanced filter at run-time checkbox has been cleared

·      When a CAML filter was manually entered that is too complex for the Filter Builder to display it

The benefit of CAML is that it applies the filter to list items before they are collected and stored by the web part, thereby improving the web part’s performance.  This is particularly beneficial when roll-ups search through a large number of lists to locate data, yet the amount of data returned could be small.  It is also useful for more complex filtering.

You do not need to know how to write CAML code; the conversion will be done automatically.  However, if you prefer to manually define a CAML filter or if the filter you want to create is too complex for the builder GUI, you can access the Filtering tab on the administration interface and select the “Click to manually build a filter” link.  A CAML field will be provided for your entry. Do NOT enter any CAML code in the Filter Builder.

Back to Top

 

Upgrading from Previous Versions XE "Upgrading from Previous Versions:Spreadsheet Roll-Up"  XE "Filtering:Conversion of Existing Filters – Spreadsheet Roll-Up"

NOTE: This topic applies to customers upgrading from a previous release to Summer 2005. It does not apply to customers upgrading from Summer 2005 to Winter 2006.

If you defined a filter in a previous version of the Workplace Suite and then upgrade to the Summer 2005 release, the web part will automatically attempt to convert the existing filter to CAML and display it in the Filter Builder; the existing filter will not be displayed in the Basic Filter field. 

When you see the filter expressions in the Filter Builder, you may notice that a filter you had defined in a previous release has been converted differently than you expected.  This is due to the way filters were processed in previous releases, and these conversions ensure that you see the same results you have always seen.  The operators that are converted differently are:

·      = (equals) – Converted to “contains”

·      Not equal to – Converted to two separate expressions, one with the “not equal to” operator and one with the “is not null” operator, placed on the lower (“or”) section of the Filter Builder

You can change the operators, or any other aspect of the filter, in the Filter Builder if you wish.  However, you should be aware that the results may vary from what you are used to seeing.

There are a few exceptions when filters will not be converted to CAML. They are:

·      When the basic filter includes an apostrophe (‘)

·      When both a basic filter and a CAML filter have been specified

·      When a basic filter is entered and the “Convert basic filter to advanced filter at run-time” checkbox has been cleared

·      When a CAML filter was manually entered that is too complex for the Filter Builder to display it

In these cases, the Filter Builder will not be displayed. Instead, the Basic Filter and CAML Filter fields for manual entry will be displayed.  This error message will be displayed: “The Filter Builder does not support the current filter settings and cannot be displayed.

Back to Top

 

Admin: Search Tab XE "Search Tab:Spreadsheet Roll-Up"  XE "Define a Search:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Web Part Properties (Pre-Summer 2005 Only)” instead.

The Search tab on the administration interface contains fields that allow you to:

·      Define where to begin the search

·      Show or hide the Search box

·      Require the user to enter search criteria before results are displayed

·      Define a required search, in which you define the criteria for the data to be displayed and remove the user's ability to perform a search

·      Configure the Search box to present a drop-down list of criteria to select from, instead of allowing a free-form search

When you are finished making your selections on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

NOTE: Searches look through all searchable fields in the schema for the identified text or data.  If you only want to look at a specific field for the text or data, a filter should be used, instead.

Show Search Box

This option enables the search bar in the roll-up display.  You can disable the search bar via a search command (:search:), but you cannot re-enable it in the same manner. To accommodate this, you can toggle this option on to re-enable the Search bar.

Wait for Search XE "Wait for Search:Spreadsheet Roll-Up"

When this feature is enabled, the web part will not return any results until the user completes a search. It can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this allows you to have multiple roll-ups on a page, each pointing a different list with a different schema, and utilizing a form web part or another connected web part as a search mechanism for all roll-ups on that page. This option was previously named “Show Nothing At Startup.”

Required Search Criteria XE "Required Search Criteria:Spreadsheet Roll-Up"

(Optional) Users are permitted to search for specific phrases to return only the information that pertains to them. However, administrators can deactivate this feature by placing a valid search phrase in this field. When this is done, the web part will return the items found via the search phrase. The fields that can be utilized in this search string are identified in the Supported Schemas section of this help, on the “Search Fields” line of each identified schema.

NOTE: If anything is entered in this field, the Search function will be deactivated for general users.

List URL

The Search box provided in a roll-up display can be configured to present a drop-down list of criteria to select from, instead of allowing a free-form search.  The List URL field is used to define the site from which this list of criteria is pulled.

The list can be located anywhere in the system. If the list exists within the same site as this web part, you can leave the Site URL field blank. As an example, say you have a list of customers located in your Sales Department sites.  In your Customer Service site, you track the calls from customers.  You can configure a roll-up view in Customer Service to include a search box that provides a drop-down list of customers that comes from the Sales Department site.

List Name

This field should state the Display Name of the list that you want to use to populate the set of available search criteria. The Display Name is the name displayed in the "Documents and Settings" area of SharePoint; it is not the URL name of the list.

NOTE: The %user% function is not supported in the administration interface. If you wish to see a list of users from the site you have chosen as a site URL or the current site, you can use the %user% parameter in the web part properties tool pane.

List Field Name

Enter the name of the field that you want to use to populate the search drop-down. The web part will look at all results within the list and return items from that list field, removing any duplicates.

NOTE: Keep in mind that this field is referenced to determine the values displayed in the search drop-down. This is not the name of the field that will be searched when the search is executed; searches look at all searchable fields identified in the schema. If you are working with a custom schema, the searchable fields are the ones you identified in the “Search” column in the Roll-Up Wizard.

 

Admin: Grouping Tab XE "Grouping Tab:Spreadsheet Roll-Up"  XE "Define Groups:Spreadsheet Roll-Up"  XE "Dynamic Grouping:Spreadsheet Roll-Up"  XE "Static Grouping:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Web Part Properties (Pre-Summer 2005 Only)” instead.

The Grouping tab on the administration interface allows you to configure the roll-up to automatically group information based on the contents of a selected field. You can also control the color and font of the group labels and specify whether or not the results should be expanded.

Spreadsheet roll-ups allow you to perform two kinds of grouping on roll-up results, static grouping and dynamic grouping.

·      With dynamic grouping, the roll-up will automatically group the results based on the values in a field that you identify.  For example, if you have a document library with four different document categories, the documents can be grouped by category, If you add a fifth document category at some point in the future, any document items with that category are automatically included in the roll-up display and grouped under that new category.

·      With static grouping, you specify not just the field you want to use to group items, but also the specific field value(s).  To continue the example used above, you would utilize static grouping if you did not want to display all of the documents with all possible document categories, but only those with a category of Requirements or Specifications.

When you are finished making your selections on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

NOTE 1: If you identify both static grouping and dynamic grouping settings, the static grouping will be performed first, followed by the dynamic grouping.

NOTE 2: If you apply grouping to a spreadsheet roll-up and right-click on the results to export them to Excel, only the group on which you clicked will be exported.

Dynamic Grouping Settings

To utilize dynamic grouping, all you need to do is select the Dynamic Grouping Field. The remainder of the fields in the Dynamic Grouping Settings section of the tab are optional.

Dynamic Grouping Field

The name of the field to reference to determine the values to group on. This must be one of the display fields within the web part. Only one field name can be identified here.

NOTE 1: If the roll-up utilizes multiple schemas, the web part will reference the first schema in the schema list to determine the available fields to display in this drop-down.

NOTE 2: Spreadsheet roll-ups do not support special characters such as “@” in dynamic grouping. If the Dynamic Grouping Field you identify contains this character, it will result in an error. The grouping will show correctly, but the group will not open when you try to expand it. The @ character is supported in static grouping, and in dynamic grouping in action-enabled roll-ups.

Group Heading Color

This field is used to identify the background color for the dynamic group headings. Click Choose Color to the right of this field to select the desired color, or you can enter the color in hex format. Leave this field blank to use the default color.

Font and Style

This field is used to identify the font family, size, color, and weight to use for the dynamic group headings. Leave this field blank to use the default font and style.

Example: font-family: Verdana; font-size: 10pt; color: blue; font-weight: bold

Expand Results

Select Yes from this field to have the roll-up display an expanded view of the results that includes site and list names, dynamic group headings, and returned items. Select No to contract the results and display only the names of each site included in the roll-up.

Static Grouping Settings

To utilize static grouping, you need to define the Group Heading Text and the Filter. The remainder of the fields in this section of the tab are optional. When defining a filter, the same rules apply as when manually defining a filter on the Filtering tab. One important difference is that filters on the Grouping tab are not converted to CAML.

When you are finished defining each group to be included in the static grouping display, click Add Grouping. When you do this, an additional set of entry fields is displayed so you can define the next group. If you want to remove a group from the display, simply click Remove Grouping below the definition of the group you want to remove.

Group Heading Text

This field is used to define the text to use for each static group heading in the roll-up display.

Filter

This field is used to define a filter to limit the items returned by the roll-up. The format is "Field=SearchText" (Example: Postal Code=11111). You can use > and < when filtering date fields.  (Example: "Date<7" will return items that are older than 7 days from today)  Filter grouping with parentheses () is not permitted. 

The fields available to use for filtering are identified in the Supported Schemas section of this help, on the “Filterable Fields” line of each identified schema.

The following values can be used for filters based on Boolean fields:

·      True

·      False

·      Yes

·      No

·      0 (translates to False)

·      1 (translates to True)

For more information on filters, visit this site: http://office.microsoft.com/en-us/assistance/HA011611751033.aspx.

NOTE: Filters defined in the Static Grouping section of the Grouping tab are not converted to CAML. Only filters defined on the Filtering tab are converted to CAML.

Heading Background Color

This field is used to select the background color to use for each static group heading in the roll-up display. Click Choose Color to the right of this field to select the desired color, or you can enter the color in hex format. Leave this field blank to use the default color.

Heading Font Color

This field is used to select the font color to use for each static group heading in the roll-up display. Click Choose Color to the right of this field to select the desired color, or you can enter the color in hex format. Leave this field blank to use the default color.

Expand Results

Select Yes from this field to have the roll-up display an expanded view of the results that includes site and list names, static group headings, and returned items. Select No to contract the results and display only the names of each site included in the roll-up.

 

Admin: Display Tab XE "Display Tab:Spreadsheet Roll-Up"  XE "Formatting:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Web Part Properties (Pre-Summer 2005 Only)” instead.

The fields on this tab are used to enable and disable aspects related to the display of items in the roll-up. For example, you can enable or hide links that allow users to edit items. Additional fields are used to define the font, style, and background color of the sites and lists named in the roll-up, as well as any dates and times included in the display.

When you are finished making your selections on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

Show Add and Edit Links

When this checkbox is selected, the "Edit Item" icon is included in the roll-up display so users can edit items from the web part.  When this checkbox is left blank, users can only view list items. Spreadsheet roll-ups do not offer “Add Item” links.

Show Column Headings

When this checkbox is selected, the field names from the list will be included as headings at the top of the roll-up display. Users will be able to click on the field headings if they want to change the sort order of the display.

Show Icons for Document XE "Document Icons:Spreadsheet Roll-Up"

This property only applies to document libraries. When this checkbox is selected, the document roll-up display will include an icon to represent the document type. When it is not selected, no icon will be included in the return.

Show Item Link

When this checkbox is selected, users can click a link to go directly to the item within the roll-up display. If you choose to leave this checkbox blank, you can use it in conjunction with the Show Site and List Links option (described below) to remove a user’s ability to go directly to a list from within the web part.

Show Site and List Links

When this checkbox is selected, the display of the site name and list name for each item returned include a clickable link.

Document Type Heading Name

This field is used to identify the name of the heading for the column that displays document type icons. It is only used when “Show Icons for Document” (described above) is selected, and it only applies to document libraries.

Number of Items per Page

This field is used to define the maximum number of items that will be displayed on each page of the spreadsheet return. A Next/Previous link will be included in the display if the number of items returned is greater than the number entered here.

Display String

This field allows you to define some of the information returned in the spreadsheet display. The format of this return allows for three variables:

·      <%Site%> - Site title where list item exists

·      <%List%> - List title where lists item exists

·      <%ListItem%> - List item Main Field returned

The format can be returned in any way, provided that the variables entered are correct. For example, you can return the List Title along with the List Item Title. This can be done by placing "<%List%> & <%ListItem%>" within the text box, where "&" can be substituted for any character or phrase or can simply be removed. You can also switch the order by place the "<%ListItem%>" before the "<%List%>".

Date Format XE "Date Format:Spreadsheet Roll-Up"

This field allows you to alter the return of date-type fields. By default, SharePoint displays date/time fields as MM/dd/yyyy, hh:mm:ss. If you wish to have all dates or times returned show only a time or a date, you can use the following parameters.

d

The day of the month. Single-digit days will not have a leading zero.

dd

The day of the month. Single-digit days will have a leading zero.

ddd

The abbreviated name of the day of the week, as defined in AbbreviatedDayNames.

dddd

The full name of the day of the week, as defined in DayNames.

M

The numeric month. Single-digit months will not have a leading zero.

MM

The numeric month. Single-digit months will have a leading zero.

MMM

The abbreviated name of the month, as defined in AbbreviatedMonthNames.

MMMM

The full name of the month, as defined in MonthNames.

y

The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.

yy

The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.

yyyy

The year in four digits, including the century.

gg

The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.

h

The hour in a 12-hour clock. Single-digit hours will not have a leading zero.

hh

The hour in a 12-hour clock. Single-digit hours will have a leading zero.

H

The hour in a 24-hour clock. Single-digit hours will not have a leading zero.

HH

The hour in a 24-hour clock. Single-digit hours will have a leading zero.

m

The minute. Single-digit minutes will not have a leading zero.

mm

The minute. Single-digit minutes will have a leading zero.

s

The second. Single-digit seconds will not have a leading zero.

ss

The second. Single-digit seconds will have a leading zero.

f

The fraction of a second in single-digit precision. The remaining digits are truncated.

ff

The fraction of a second in double-digit precision. The remaining digits are truncated.

fff

The fraction of a second in three-digit precision. The remaining digits are truncated.

ffff

The fraction of a second in four-digit precision. The remaining digits are truncated.

fffff

The fraction of a second in five-digit precision. The remaining digits are truncated.

ffffff

The fraction of a second in six-digit precision. The remaining digits are truncated.

fffffff

The fraction of a second in seven-digit precision. The remaining digits are truncated.

t

The first character in the AM/PM designator defined in AMDesignator or PMDesignator, if any.

tt

The AM/PM designator defined in AMDesignator or PMDesignator, if any.

z

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8".

zz

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".

zzz

The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00".

:

The default time separator defined in TimeSeparator.

/

The default date separator defined in DateSeparator.

 

Back to Top

 

Sorting Options XE "Sorting:Spreadsheet Roll-Up"  XE "Define a Sort:Spreadsheet Roll-Up"

The Sorting Options section of the Display tab allows you to define how roll-up results are sorted.  In the past, you could click on a column heading to change the way a roll-up was sorted, but the default sort would resume the next time you returned to the display.  Now, these settings enable you to “lock in” the desired sort order.  You can select up to three fields to sort on in a single roll-up.

 XE "Sorting:Multiple Schemas" Because a roll-up can reference multiple schemas, each of which can reference columns with different names, you need to identify the schema you want to work with when defining a custom sort. 

The steps to define a custom sort are as follows:

1.  Place the roll-up web part on the page and make the appropriate site and list selections, plus any other web part property settings necessary on the administration interface.

2.  Access the Display tab and select the first schema you want to work with from the Schema for Sort Order field. Note that the schemas listed in this drop-down are limited to the schema(s) you chose on the Sites and Lists tab.

3.  Use the drop-down fields and radio buttons below the Schema for Sort Order field to define the fields and order to use to sort the roll-up results.  You can sort on up to three fields; if you want to sort on only one or two fields, leave the other drop-down(s) blank.

NOTE: As of with Summer 2005, all fields in the schema are available for sorting.  Past versions of the Workplace Suite only allowed you to sort on certain fields that were identified for sorting in the schema.

4.  Click Apply.

5.  Select the next schema from the Schema for Sort Order field, then select the desired fields and sort order as described above.

6.  When you are finished, click Apply or OK.  All of your changes are saved, including all of the sort rules defined above.

 

Back to Top

 

Admin: Localization Tab XE "Localization Tab:Spreadsheet Roll-Up"  XE "Localization:Spreadsheet Roll-Up"  XE "Language:Spreadsheet Roll-Up"  XE "Translation:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Web Part Properties (Pre-Summer 2005 Only)” instead.

The Localization tab allows you to customize the messages, prompts, button labels, and options displayed by the web part (e.g., link to add a new item, message displayed when no records meet the criteria for the roll-up, etc.). It also allows you to customize all of the text on the administration interface, including tab and section names and descriptions, field names, drop-down field options, and button labels.  Content is grouped by the tab on which it appears. 

An additional section on this tab, which is labeled with the web part name, allows you to modify the following:

·      Administration interface tab names

·      Messages displayed to users (e.g., no items found, web part time out, prompt to execute a search)

·      Search button label

·      Text used for “Add Item” link

·      Text used for “Actions” and “Show Version” options on web part menu

·      Text used for options presented when “Actions” is selected from web part menu

To customize any of this information, simply locate the text you want to change and type over it with the desired content.

Use the Filter at the top of the tab to easily find content. Just type the content you're looking for and then click Filter.

To reset a value back to its default, delete the value in the text box and apply the changes by clicking OK or another administration tab. The next time the corresponding tab loads, the default value will be displayed.

When you are finished making the necessary changes on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

You may find it helpful to open another browser session and view the results of your customizations as you save your changes.

NOTE 1: A new DisplayXML property replaces the LCIDXML property. For users that have entered LCIDXML in previous roll-ups, the LCIDXML will be upgraded to the new DisplayXML property automatically.  Summer 2005 and later releases do not support manual edits of the DisplayXML. The Localization tab should be used instead.

NOTE 2: The DisplayXML for Summer 2005 and later releases do not support more than one language.  If your previous LCIDXML property was set up for multiple languages, the ‘default’ LCID will be used.

 

Admin: Other Tab XE "Other Tab:Spreadsheet Roll-Up"  XE "SPS My Site:Spreadsheet Roll-Up"

NOTE: This topic applies only to Advanced Spreadsheet Roll-Ups from Summer 2005 and later releases. If you are working with a prior release, please see “Web Part Properties (Pre-Summer 2005 Only)” instead.

The top few fields on this tab are used to define how URLs and links provided within the roll-up should be displayed. The remaining field is used to enable multi-threading, which causes roll-ups to share processing power, rather than allowing a single roll-up to consume all available resources.

When you are finished making the necessary changes on this tab, click any other administration tab to save your changes and keep the administration interface open, or click OK to save your changes and return to the roll-up display.

SPS My Site Path XE "SPS My Site:Spreadsheet Roll-Up"

This field allows you to change the default SPS My Site characteristics of the web part. By default, the web part will modify the URL "/mysite" to point to "/personal/User". This allows the web part to search through the MySite section of SharePoint Portal Server. However, SPS allows the administrator to alter the URL definition for each SPS server. To accommodate this, the SPS My Site Path field allows you to alter the web part to support your organization’s SPS MySite setup.

Target Window

This entry allows you to define the target window for the links provided in the web part. For example, if you wanted any links that are clicked on to open in a new window, you would type “_new” in this field. Valid options include:

·      _blank

·      _new

·      _parent

·      _self

Root Folder for Documents

This setting applies to Document roll-ups only.

This field is used to identify the root folder where documents reside within a list. This property is required in order to permit editing and/or linking to an item. Since this list property is language-dependant, the equivalent (URL Dir Name) must be entered if a different language is chosen.

Direct Location of Documents

This setting applies to Document roll-ups only.

This field is used to identify the direct location where documents reside within a list. This property is required in order to permit direct linking to an item. Since this list property is language-dependant, the equivalent (Encoded Absolute URL) must be entered if a different language is chosen.

Show URLs as Text, Not Links

By default, CorasWorks Web parts will attempt to categorize text as a URL. If this checkbox is selected and you have text with a format of "http://www.site.com" it will translate this text to a URL and automatically place the correct tags around it to make it clickable. If you do not want this to occur, clear the checkbox to disable this feature.

Go Directly to Document XE "Documents - Go Directly To:Spreadsheet Roll-Up"

This setting applies to Document roll-ups only.

When this checkbox is selected and an item in a document library is returned by the web part, the item link will go directly to the document returned. When the checkbox is left blank, the item link will take the user directly to the edit page for the item. This property only functions for document library types.

Thread Web Part XE "Thread Web Part:Spreadsheet Roll-Up"

When this checkbox is selected, the web part (Web Part A in the example below) is allowed to manage its own threads, rather than submitting threads to be serially queued in the SharePoint thread management process. This allows parallel execution of multiple web parts, improving server performance under heavy loads.

NOTE: This option should only be enabled if you meet the following criteria.

·      Your web server has multiple processors

·      Web Part A is being used for heavy transactions against SQL server, returning 1000+ Items

·      There is a heavy user load on web part A

·      You have configured the IIS application pool corresponding to the virtual server to use multiple worker processes (a.k.a. Web Garden)

Enabling this option on Web Part A may not improve the performance of Web Part A. However, this option is designed to allow Web Part A to run independently of the SharePoint web part queue. This means that control will be returned to the SharePoint process more rapidly, allowing other web parts and web part pages to be rendered while the “expensive” Web Part A is running.

IMPORTANT! Only perform the following steps if you understand the use and impact of editing the web.config file.

If you enable this option and notice that the web part times out, you will be required to update the web.config for the virtual server hosting the site where this web part is being used.

NOTE: Make a copy of the web.config file before attempting the following.

The web.config file has a line which states "<WebPartWorkItem Timeout="7000" />". This specifies the amount of time given to a thread to collect and present data. If you are collecting large amounts of data, this may need to be increased to support this higher load. The 7000 represents 7000 milliseconds. If you wish to allow a thread to execute for a longer period, you must change this to the value you require. (Example: 60 Seconds = 60000). Some experimentation may be required.

 

Administration View (Pre-Summer 2005 only)  XE "Administration Window:Spreadsheet Roll-Up"

NOTE: This topic applies only to versions of Advanced Spreadsheet Roll-Ups from before the Summer 2005 release. If you are working with Summer 2005 or a later release, please see “Admin: Sites and Lists Tab” instead.

The Administration View of a roll-up web part is displayed when you first drag and drop the web part onto a page. It can also be accessed via the Actions menu. This view is used to select the sites, portals, and/or sub-areas and lists to include in the user presentation of the roll-up. You can select any number of lists or libraries from any number of sites on the server that the web part is running on as the source for the roll-up.

Return Type XE "Return Type:Spreadsheet Roll-Up"  XE "Selective Return Type:Spreadsheet Roll-Up"  XE "Line of Site Return Type:Spreadsheet Roll-Up"

This field is used to specify how the web part should identify the sites and lists to include in the roll-up display.

·      Selective allows you to select each specific list that you want to include. If you choose Selective, the "Available Lists" and "Current Lists" fields will be activated.

·      Line of Site enables you to identify a URL and the number of levels below that URL to include in the display. Any sites that exist now or are created in the future within the specified number of levels will be automatically recognized and included in the roll-up display. If you choose Line of Site, the "Available Lists" and "Current Lists" fields are not used. Make sure you click the "Save Selection" button to save the settings entered in the "Site URL" and "Levels Searched" fields.

Did you know… With Selective roll-ups, you can reference a list to which your users have read access in a site to which they do not have access. This is because Selective roll-ups hard-code the URL of the site and list, and do not check to see if the user has access to the entire site, as Line of Site roll-ups do.

Site URL XE "Site URL:Spreadsheet Roll-Up"

This optional field is used to define the URL for the site (or the top-level site) you want to access and from which you want to return list items. This can be any SharePoint site that resides on the same server as this web part. If this field is left blank, it will default to the URL where the web part is placed.

The format for the URL is http://Site-URL/SiteName.

Examples:

·      http://www.sitename.com/

·      http://www.sitename.com/site1

·      http://www.sitename.com/site1/site1a

To include lists from more than one site, you can place a semicolon (;) between the URLs you want to access. Make sure there is no space between the first URL, the semicolon, and the second URL.

Example:
http://www.sitename.com;http://www.othersitename.com/site
This applies to both Selective and Line of Site return types.

TIP: If the site that contains the lists you want to work with is displayed by the Workplace View Advanced web part, you can right-click on the site, select Copy Shortcut, and paste the URL in the Site URL field.

Levels Searched XE "Levels Searched:Spreadsheet Roll-Up"

This optional field is used to define the number of levels to search within a site to find lists for the roll-up display. If this field is left blank, it will default to 0, which searches only the site named in the “Site URL” field. The maximum recommended number of levels is 10.

Please make sure that a number is entered in this field. If you spell out a number, it will result in an error and no lists will be found.

Schema(s)

This drop-down field lists all of the available schemas that can be used with this web part. The default is “Utilize All Schemas.” However, you can choose to include only those lists that utilize a particular schema. This can be useful if you want to narrow your search to those list templates that include the fields that you want to use.

Schemas contain the elements that identify a list: the list type, filter and search fields, display fields, and so on. When you select a schema, the elements of that schema will be used to find only those lists that match that schema profile. Lists of schemas can be found in the Supported Schemas section of this web part help.

If you have created your own schemas, you will not be able to select them from the Schemas drop-down for the out-of-the-box CorasWorks Spreadsheet roll-ups. You will need to create your own version of the roll-up web part that references your custom schema using the Roll-Up Wizard, which is available with the Developer and Small Business editions of the Workplace Suite.

Return Sites & Lists (Selective Only)

This button will execute a search of the chosen site structure and then display the sites and lists that match your criteria in the "Available Lists" drop-down field.

Save Selection (Line of Site Only)

This button will save your web part settings for the Line of Site return type. You must click this button if a change has been made to the selections in the “Site URL”, “Levels Chosen”, or “Schema” fields.

Available List(s) (Selective Only)  XE "Available Lists:Spreadsheet Roll-Up"

This area displays the lists available to be chosen for return by the web part. This includes all available lists, even if they have already been selected and are displayed in the "Current List(s)" field. The format for the lists displayed in this field is “Site Name | List Name.”

Select a list to add it to the web part display. Select "Add All Sites & Lists" to include items from all of the lists returned in the web part display.

Current List(s) (Selective Only)  XE "Current Lists:Spreadsheet Roll-Up"

This area displays all of the lists you have selected to include in the roll-up display. The format for the lists displayed in this field is “Site Name | List Name.”

To remove a list, simply highlight the list and it will be removed from the display. Select "Remove All Sites & Lists" to remove all of the lists from the roll-up display.

Close Administration

This button closes the Administration view and returns you to the web part’s data view.

 

Web Part Properties (Pre-Summer 2005 only)  XE "Web Part Properties:Spreadsheet Roll-Up"

NOTE: This topic applies only to versions of Advanced Spreadsheet Roll-Ups from before the Summer 2005 release. If you are working with Summer 2005 or a later release, please see the corresponding “Admin” topic instead.

Administration Properties XE "Administration Properties:Spreadsheet Roll-Up"

Enable Multi-Threading

This performance enhancement feature allows the web part (webpartA in the example below) to manage its own threads rather than submitting threads to be serially queued in the SharePoint thread management process. This allows parallel execution of multiple web parts, improving server performance under heavy loads.

NOTE: This option should only be enabled if you meet the following criteria.

·      Your web server has multiple processors

·      WebpartA is being used for heavy transactions against SQL server, returning 1000+ Items

·      There is a heavy user load on webpartA

·      You have configured the IIS application pool corresponding to the virtual server to use multiple worker processes (aka 'Web Garden')

Enabling this option on webpartA may not improve the performance of webpartA. However, this option is designed to allow webpartA to run independently of the SharePoint web part queue. This means that control will be returned to the SharePoint process more rapidly, allowing other web parts and web part pages to be rendered while the “expensive” webpartA is running.

IMPORTANT! Only perform the following steps if you understand the use and impact of editing the web.config file.

If you enable ThreadWebPart and notice that the web part times out, you will be be required to update the web.config for the virtual server hosting the site where this web part is being used.

NOTE: Make a copy of the web.config file before attempting the following.

The web.config file has a line "<WebPartWorkItem Timeout="7000" />". This specifies the amount of time given to a thread to collect and present data. If you are collecting large amounts of data, this may need to be increased to support this higher load. The 7000 represents 7000 milliseconds. If you wish to allow a thread to execute for a longer period, you must change this to the value you require. (Example: 60 Seconds = 60000). Some experimentation may be required.

Show Search Bar

The selectable choice will enable or disable the search bar. While you can via a Search Command disable the search bar, you cannot re-enable it with a search command as the search bar is now hidden. To re-enable the search select toggle this choice to display the search bar.

Show Roll-Up Administration (version 3.25 Only)

This option shows the web part’s administration window, allowing administrators to manage the lists and schemas utilized by the web part. This view is only available to administrators of the Site or Web, or it can be viewed within in a Shared View.

Back to Top

 

Display Properties XE "Display Properties:Spreadsheet Roll-Up"

Show Edit/Create Ability

This option activates the "Add Item" link and "Edit Item" icon on the roll-up display. When activated, users can add and edit items from the web part.  When deactivated, users can only display the list item.

Show Link to Sites/Lists

When this option is enabled, a selectable link is provided when the site name and list name are shown for each list item.

Show Link To Item

When this option is enabled, users can click a link to go directly to the item within the roll-up display. Use this in conjunction with the Show Links to Site/Lists option to remove a user’s ability to go directly to a list from within the web part.

Show List Headers

When this option is enabled, the field names from the list will be included as headings at the top of the roll-up display. Users will be able to click on the field headings if they want to change the sort order of the display.

Show URLs As Text Only

By default, CorasWorks Web parts will attempt to categorize text as a URL. If you have text with a format of "http://www.site.com" it will translate this text to a URL and automatically place the correct tags around it to make it clickable. If you do not want this to occur, toggle this switch on to disable this automatic feature.

Display Parameters

This option allows you to define some of the information returned in the spreadsheet display. The format of this return allows for three variables:

·      <%Site%> - Site title where list item exists

·      <%List%> - List title where lists item exists

·      <%ListItem%> - List item Main Field returned

The format can be returned in any way, provided that the variables entered are correct. For example, you can return the List Title along with the List Item Title. This can be done by placing "<%List%> & <%ListItem%>" within the text box, where "&" can be substituted for any character or phrase or can simply be removed. You can also switch the order by place the "<%ListItem%>" before the "<%List%>".

Show Link to Sites/Lists

If this option is enabled, the site name and list name for each item will be hyperlinked within the display.  If this option is disabled, the site and list names will be displayed without links.

Number of Results

This feature allows you to control the maximum number of items that will be displayed on each page of the spreadsheet. A Next/Previous link will be made available if the number of items returned is greater than the number entered here.

Back to Top

 

Return Properties XE "Return Properties:Spreadsheet Roll-Up"

Show Nothing At Startup  XE "Performance Features:Show Nothing At Startup - Spreadsheet Roll-Up"  XE "Show Nothing at Startup:Spreadsheet Roll-Up"

This feature allows the web part to return no results until the user completes a search. It can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this allows you to have multiple roll-ups on a page, each pointing a different list with a different schema, and utilizing a form web part or another connected web part as a search mechanism for all roll-ups on that page.

Required Search String

(Optional) Users are permitted to search for specific phrases to return only the information that pertains to them. However, Administrators can deactivate this feature by placing a valid search phrase in the Required Search String field. When this is done, the web part will return the items found via the search phrase. The fields that can be utilized in this search string are identified in the Supported Schemas section of this help, on the “Search Fields” line of each identified schema.

NOTE: If anything is entered in this field, the Search function will be deactivated for general users.

Filter

(Optional) Administrators can use the Filter field to control the web part’s return at a higher level. Unlike the Required Search String (above), Administrators can specify the field to search and, if anything is entered here, users will still be able to search on the filtered return.

The format for this property is "Field=SearchText" (Example: Postal Code=11111) with no space between the field and the search text. You can also use > and < when filtering date fields. (Example: "Date<7" will return items that are older than 7 days from today.) This only works on filterable fields that are designated as date fields. Filter grouping with parentheses () is not permitted.

The fields available to use for filtering are identified in the Supported Schemas section of this help, on the “Filterable Fields” line of each identified schema.

Keep in mind the fact that filters look for values in a specific field. If you want to look for a specific value in any field, use a search, instead.

Examples:

Requirement 1:
Show me all tasks that are assigned to me and are due within seven days

Use:
Assigned To=[ME] && Due Date>-1 && Due Date<7

Requirement 2:
Show me all tasks that are assigned to me or to someone else

Use:
Assigned To=ME' || Assigned To=UserName

Requirement 3:
Show me all tasks that are not assigned to me

Use:
Assigned To<>[ME]

Where:

·      && = And

·      || = Or

·      <> = Not

·      [ME] = Currently Logged In User

 

Tips on Defining Filters

1. Available Columns for Filter Definition

Columns do not have to be displayed in order to be referenced in a filter, but they do need to be searchable.  To make a column searchable, the Search box must selected when the roll-up is created via the Roll-Up Wizard. By default, all columns that are selected in the Roll-Up Wizard for display are also marked as searchable.

2. Contains vs. Is Equal To or =

Because SharePoint sometimes stores data differently than the way it is displayed, you may find that you get better results from your filters when you use the "Contains" operator instead of "Is Equal To" or “=”.

For example, you may see the name "Bob Smith" in a list item that includes the Assigned To field. However, SharePoint stores this name with extra characters, so the actual stored value may be something like "3;#Bob Smith." Therefore, if you want to filter on records that were assigned to Bob, you get the desired results if you build the filter with the "Contains" operator.

3. Using Yes/No Columns vs. Choice Columns with Yes/No Options

It is important to understand the difference between Yes/No columns and Choice columns with Yes and No options.

When you use a Yes/No column, SharePoint stores a “True” value when the field is selected and leaves it blank when it is not selected. As a result, if you want to filter on a Yes/No column, you need to set the filter to look for the appropriate value:

·      To filter on a selected (Yes) value, the filter would be “column=True” (replace “column” with the name of your column)

·      To filter on a non-selected (No) value, the filter would be “column<>True”

When you use a Choice column with Yes and No options, the filter should be defined as “column=value”.

 

Static Grouping Filter XE "Static Grouping:Spreadsheet Roll-Up"

This entry allows the user to specify a series of grouped filters to group items by the filter used. Along with setting multiple filters, the user can specify a topic heading, color of the tree-view, font color, and whether or not the display is expanded or contracted by default. This property is overridden if a filter is set in the Filter properties box.

You can use this field and the DynamicGrouping field if you wish to provide a grouped filter followed by a dynamic grouping. If you wish to define more than one static grouping filter, you can do so by separating each filter with a <NEW> tag.

Use: header text;filter;tree-view color;fontcolor;true/false
Example: Tasks Past Due;Due Date<1;red;white;true
Settings: First Element = Header Text, Second Element = Filter, Third Element = Tree-View Background Color, Fourth Element = Font Color, Fifth Element = Expanded/Contracted (true/false)

Back to Top

 

Dynamic Grouping XE "Dynamic Grouping:Spreadsheet Roll-Up"

This entry allows you to automatically group items by the values in a particular field.  For example, if you have a task list with five different statuses, the tasks can be grouped by status.  If you add a sixth status value, any items with that status are automatically included in the display and grouped under that new status.

The field you identify must be one of the display fields within the web part, and only one field can be used at a time.

NOTE: Spreadsheet roll-ups do not support special characters such as “@” in dynamic grouping. If the Dynamic Grouping Field you identify contains this character, it will result in an error. The grouping will show correctly, but the group will not open when you try to expand it. The @ character is supported in static grouping, and in dynamic grouping in action-enabled roll-ups.

Dynamic Grouping Properties

This entry allows the administrator to specify the look and feel of the dynamic grouping by identifying the background color, font style, and whether or not the results should be expanded or contracted. If no property is chosen the default properties and/or "FontSytle" or "TDColor" will be used. Each element of this property must be separated by a comma, with no space is separated between each element and the comma. Colors can be defined using either hex format or the direct color name.

Use: Row Color,Font Style,true/false
Example: blue,font-family: Verdana; font-size: 8pt; color: white; font-weight: bold,true
Settings: First Element = Tree-View TD Background Color, Second Element = Tree-View Font Style, Third Element = Expanded/Contracted (true/false)

Displayable Date Format

This property allows you to alter the return of those fields which are of a date type. SharePoint, by default, will store any date/time field as MM/dd/yyyy, hh:mm:ss. If you wish to have all dates or times returned show only a time or a date, you can use the following parameters.

d

The day of the month. Single-digit days will not have a leading zero.

dd

The day of the month. Single-digit days will have a leading zero.

ddd

The abbreviated name of the day of the week, as defined in AbbreviatedDayNames.

dddd

The full name of the day of the week, as defined in DayNames.

M

The numeric month. Single-digit months will not have a leading zero.

MM

The numeric month. Single-digit months will have a leading zero.

MMM

The abbreviated name of the month, as defined in AbbreviatedMonthNames.

MMMM

The full name of the month, as defined in MonthNames.

y

The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.

yy

The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.

yyyy

The year in four digits, including the century.

gg

The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.

h

The hour in a 12-hour clock. Single-digit hours will not have a leading zero.

hh

The hour in a 12-hour clock. Single-digit hours will have a leading zero.

H

The hour in a 24-hour clock. Single-digit hours will not have a leading zero.

HH

The hour in a 24-hour clock. Single-digit hours will have a leading zero.

m

The minute. Single-digit minutes will not have a leading zero.

mm

The minute. Single-digit minutes will have a leading zero.

s

The second. Single-digit seconds will not have a leading zero.

ss

The second. Single-digit seconds will have a leading zero.

f

The fraction of a second in single-digit precision. The remaining digits are truncated.

ff

The fraction of a second in double-digit precision. The remaining digits are truncated.

fff

The fraction of a second in three-digit precision. The remaining digits are truncated.

ffff

The fraction of a second in four-digit precision. The remaining digits are truncated.

fffff

The fraction of a second in five-digit precision. The remaining digits are truncated.

ffffff

The fraction of a second in six-digit precision. The remaining digits are truncated.

fffffff

The fraction of a second in seven-digit precision. The remaining digits are truncated.

t

The first character in the AM/PM designator defined in AMDesignator or PMDesignator, if any.

tt

The AM/PM designator defined in AMDesignator or PMDesignator, if any.

z

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8".

zz

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".

zzz

The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00".

:

The default time separator defined in TimeSeparator.

/

The default date separator defined in DateSeparator.

 

Target Frame

This entry allows you to have a different target for all links displayed in the web part. If you wish to have any item clicked on open a new window you can enter "_blank" or "_new". If you wish to have any link click on open within the current browser window you can enter "_parent" or "_self".

Back to Top

 

Search List Properties XE "Search List Properties:Spreadsheet Roll-Up"

The following properties allow you to connect another list from any other site to this web part. This allows you to use the results stored in one field for searches within the web part, providing your users a list of standard search criteria to select from, instead of a free-form search.

The list can come from a column of any list located anywhere in the system.  As an example, say you have a list of customers located in your Sales Department sites.  In your Customer Service site, you track the calls from customers.  You can configure a roll-up view in Customer Service to include a drop-down list of customers that comes from the Sales Department site.

NOTE: Searches look through all searchable fields in the schema for the identified text or data.  If you only want to look at a specific field for the text or data, a filter should be used, instead.

Site URL

Enter the Site URL of the site that you would like to access a list from. If the list exists within the same site as this web part, no Site URL is required.

List Name

Enter the "Display Name" of the list that you would like to return. The Display Name is the name displayed in the "Documents and Settings" area of SharePoint. It is not the URL name of the list. If you wish to see a list of users from the site you have chosen as a site URL or the current site, you can use the parameter "%USER%".

Field Name

Enter the Field Name of the field that you want to use to populate the search drop-down. The web part will look at all results within the list and return items from that list field, removing any duplicates.

If you identified the "%USER%" parameter in the List Name field above, you can utilize the "email", "loginname", or "username" field. These will allow you to select the email address, login name, or user name of the individuals who have access to the site.

NOTE: Keep in mind that this field is referenced to determine the values displayed in the search drop-down. This is not the name of the field that will be searched when the search is executed; searches look at all searchable fields in the schema.

Back to Top

 

Actions Menu XE "Actions Menu:Spreadsheet Roll-Up"

The Actions menu allows both administrators and users to execute common actions in lieu of utilizing search commands. The Show Version action is available to all users on the system. 

To use the Actions menu and view version information, go to the web part and drop down the web part menu options by clicking on the down arrow on the top right hand side of the web part.  Drag your mouse over "Actions" and then choose the desired option.

Show Admin XE "Administration View:Spreadsheet Roll-Up"

If you are working with Summer 2005 or a later release, this option causes the administration interface to be displayed. If you are working with a prior release, this option causes the web part’s administration window to be displayed. In either case, the resulting display allows administrators to determine the lists and schemas utilized by the web part. This option is only available to administrators.

Show Version XE "Version:Spreadsheet Roll-Up"  XE "Show Version:Spreadsheet Roll-Up"

This selection will show version information within the web part area, including application, version, organization, authors, and build date. The link to Close Version Window returns the page back to it original state.

NOTE: Because all CorasWorks web parts utilize this command for version viewing, every CorasWorks web part on the page will respond to the Show Version action. This will allow you to view version information for all CorasWorks web parts at once.

Connectability XE "Connectability:Spreadsheet Roll-Up"

Connectability is a standard protocol that is supported within a SharePoint environment. CorasWorks navigation and roll-up components can utilize the connectability interface so CorasWorks web parts can “talk” to one another and one web part can receive information from another web part. This information can be used to alter the data displayed within the current web part.

You can only activate a connection when the page is in Design mode. Once in Design mode, access the web part menu and select Connections. Then specify the type of connection you want and the web part you want to connect to.

The three currently supported types of connections are List Consumer, Row Consumer, and Cell Consumer.

List Consumer XE "List Consumer:Spreadsheet Roll-Up"  XE "Connectability:List Consumer - Spreadsheet Roll-Up"

This type of connection allows you to “consume” a list of URLS from the Workplace View Advanced 3.5 (WVA) or the SPS Workplace View Advanced 3.5 (SPS WVA). This allows you to set up your site information within one web part and have its setting reflect within this web part. This type of connection does not accept information from any other web part.

For example, imagine that there are multiple roll-up views on a page. All of these roll-ups can be connected to the WVA. When you change the sites and lists in the WVA, the roll-ups will update to show the information selected. This reduces the time to reconfigure individual web parts and ensures that they all have the correct configuration.

Cell Consumer XE "Cell Consumer: Spreadsheet Roll-Up "  XE "Connectability:Cell Consumer - Spreadsheet Roll-Up "

This type of connection allows you to consume a specific cell from within another web part. After a connection has been established, you will be asked what cell you would like to read from the other web part. After you have chosen a specific field (cell), the title of the column from the other web part will be used to filter against by default. If you want to filter on a different cell within your returned data, you can specify this within the Connectable Properties section of the web part properties.

Cell consumer connections that include calculated values are not supported.

As an example, imagine that you want to provide a salesperson with information about a customer. You may want to create a page that has contact information about the customer, order information, call history, and support calls. Using connectability, you can connect the web parts so that when you select a customer, the other views for orders, call history, and support calls will automatically update to display that customer’s information.

Because CorasWorks roll-ups can show information from any sites or portal sub-areas, the data, such as the call history list or the support calls, can be stored in different sites, such as departmental sites.  With connectability, you can simply select a customer and all of the information for that customer is displayed.  This type of scenario would also apply, for instance, in situations where you want to see information about projects which are stored in sites for different departments.  The key is that each list has to have a field with the exact same name and the same data type, such as Customer ID or Project ID.

Modifiable DWP Properties XE "DWP Properties: Spreadsheet Roll-Up"

CorasWorks web parts have a number of properties that can only be modified by manually editing the DWP file associated with this web part. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

These properties allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the 0For DevelopersHelp_D2HPrivate(-9,656)Overview0 help topic.

Also note that some of these properties some may require the use of a "<", ">", or "&" symbol. If that is the case, you will need to replace these characters with their encoded equivalents of "&lt;", "&gt;", and "&amp;" respectively.

These properties are only viewable in the DWP if the default settings have been changed.

NOTE: As of the Summer 05 release of the Workplace Suite, a Localization tab on the administration interface allows you to make many of the localization changes described below. Before you make these changes in the DWP, you may want to review the available settings that can be modified on the Localization tab.

CAML (String)

This performance enhancement feature allows you to have a pre-collection CAML query execute against lists accessed by this web part. This can greatly improve performance of this web part as information will not be collected that is not pertinent to the view attempting to be achieved. For more information about CAML queries, please see: Collaborative Application Markup Language. It is important to note that since CAML by its nature is XML and a DWP is XML you must encode the CAML query replacing < with a &lt;, > with a &gt;, & with a &amp;, and " with a &quot;. If you do not do this then the DWP will error and web part will not function.

Use: <CAML xmlns="webpart_namespace">CAML Query</CAML>

Example: <CAML xmlns="CorasWSC.My.Task.RollUp">&lt;Where&gt;&lt;Neq>&lt;FieldRef Name='Status'/&gt;&lt;Value Type='Text'&gt;Completed&lt;/Value&gt;&lt;/Neq&gt;&lt;/Where&gt;</CAML>

DateFormat (String)

This property allows you to alter the return of those fields which are of a date type. SharePoint, by default, will store any date/time field as MM/dd/yyyy, hh:mm:ss. If you wish to have all dates or times returned show only a time or a date, you can use the following parameters.

d

The day of the month. Single-digit days will not have a leading zero.

dd

The day of the month. Single-digit days will have a leading zero.

ddd

The abbreviated name of the day of the week, as defined in AbbreviatedDayNames.

dddd

The full name of the day of the week, as defined in DayNames.

M

The numeric month. Single-digit months will not have a leading zero.

MM

The numeric month. Single-digit months will have a leading zero.

MMM

The abbreviated name of the month, as defined in AbbreviatedMonthNames.

MMMM

The full name of the month, as defined in MonthNames.

y

The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.

yy

The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.

yyyy

The year in four digits, including the century.

gg

The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.

h

The hour in a 12-hour clock. Single-digit hours will not have a leading zero.

hh

The hour in a 12-hour clock. Single-digit hours will have a leading zero.

H

The hour in a 24-hour clock. Single-digit hours will not have a leading zero.

HH

The hour in a 24-hour clock. Single-digit hours will have a leading zero.

m

The minute. Single-digit minutes will not have a leading zero.

mm

The minute. Single-digit minutes will have a leading zero.

s

The second. Single-digit seconds will not have a leading zero.

ss

The second. Single-digit seconds will have a leading zero.

f

The fraction of a second in single-digit precision. The remaining digits are truncated.

ff

The fraction of a second in double-digit precision. The remaining digits are truncated.

fff

The fraction of a second in three-digit precision. The remaining digits are truncated.

ffff

The fraction of a second in four-digit precision. The remaining digits are truncated.

fffff

The fraction of a second in five-digit precision. The remaining digits are truncated.

ffffff

The fraction of a second in six-digit precision. The remaining digits are truncated.

fffffff

The fraction of a second in seven-digit precision. The remaining digits are truncated.

t

The first character in the AM/PM designator defined in AMDesignator or PMDesignator, if any.

tt

The AM/PM designator defined in AMDesignator or PMDesignator, if any.

z

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8".

zz

The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".

zzz

The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00".

:

The default time separator defined in TimeSeparator.

/

The default date separator defined in DateSeparator.

 

DateSLDisplay (String)

This property allows the user to specify a series of grouped filters to group items by the filter used. Along with setting multiple filters, the user can specify a topic heading, color of the tree-view, font color, and whether or not the display is expanded or contracted by default. This property is overridden if a filter is set in the Filter properties box.

You can use this field and the DynamicGrouping field if you wish to provide a grouped filter followed by a dynamic grouping. If you wish to define more than one static grouping filter, you can do so by separating each filter with a <NEW> tag.

Use: header text;filter;tree-view color;fontcolor;true/false
Example: Tasks Past Due;Due Date<1;red;white;true
Settings: First Element = Header Text, Second Element = Filter, Third Element = Tree-View Background Color, Fourth Element = Font Color, Fifth Element = Expanded/Contracted (true/false)

DisplayString (String)

This parameter allows you to define some of the information returned in the spreadsheet display. The format of this return allows for three variables:

·      <%Site%> - Site title where list item exists

·      <%List%> - List title where lists item exists

·      <%ListItem%> - List item Main Field returned

The format can be returned in any way, provided that the variables entered are correct. For example, you can return the List Title along with the List Item Title. This can be done by placing "<%List%> & <%ListItem%>" within the text box, where "&" can be substituted for any character or phrase or can simply be removed. You can also switch the order by place the "<%ListItem%>" before the "<%List%>".

DontConvertHttp (Boolean)

By default, CorasWorks Web parts will attempt to categorize text as a URL. If you have text with a format of "http://www.site.com" it will translate this text to a URL and automatically place the correct tags around it to make it clickable. If you do not want this to occur, toggle this switch on to disable this automatic feature.

DynamicGrouping (String)

This entry allows you to automatically group items by the values in a particular field.  For example, if you have a task list with five different statuses, the tasks can be grouped by status.  If you add a sixth status value, any items with that status are automatically included in the display and grouped under that new status.

The field you identify must be one of the display fields within the web part, and only one field can be used at a time.

DynamicGroupingProperties (String)

This entry allows the administrator to specify the look and feel of the dynamic grouping by identifying the background color, font style, and whether or not the results should be expanded or contracted. If no property is chosen the default properties and/or "FontSytle" or "TDColor" will be used. Each element of this property must be separated by a comma, with no space is separated between each element and the comma. Colors can be defined using either hex format or the direct color name.

Use: Row Color,Font Style,true/false
Example: blue,font-family: Verdana; font-size: 8pt; color: white; font-weight: bold,true
Settings: First Element = Tree-View TD Background Color, Second Element = Tree-View Font Style, Third Element = Expanded/Contracted (true/false)

Filter (String)

Administrators can use the Filter field to control the web part’s return at a higher level. Unlike the Required Search String (above), Administrators can specify the field to search and, if anything is entered here, users will still be able to search on the filtered return.

The format for this property is "Field=SearchText" (Example: Postal Code=11111) with no space between the field and the search text. You can also use > and < when filtering date fields. (Example: "Date<7" will return items that are older than 7 days from today.) This only works on filterable fields that are designated as date fields. Filter grouping with parentheses () is not permitted.

The fields available to use for filtering are identified in the Supported Schemas section of this help, on the “Filterable Fields” line of each identified schema.

Keep in mind the fact that filters look for values in a specific field. If you want to look for a specific value in any field, use a search, instead.

Examples:

Requirement 1:
Show me all tasks that are assigned to me and are due within seven days

Use:
Assigned To=[ME] && Due Date>-1 && Due Date<7

Requirement 2:
Show me all tasks that are assigned to me or to someone else

Use:
Assigned To=ME' || Assigned To=UserName

Requirement 3:
Show me all tasks that are not assigned to me

Use:
Assigned To<>[ME]

Where:

·      && = And

·      || = Or

·      <> = Not

·      [ME] = Currently Logged In User

 

LevelCount (String)

Enter the amount of levels to be searched to return the list items displayed by the web part. Do not spell out the number, or you will receive an error and no lists will be found.

ListNames (String)

The lists available to be chosen for return by the web part.

ListTemplates (String)

This is the list of the WSS List types the Roll-Up Wizard works with.

MySite (String)

This property will allow you to change the default MySite characteristics of the Web Part. Currently the Web Part will modify the URL "/mysite" to point to "/personal/User". This allows the web part to search through the MySite section of SharePoint Portal Server. SPS allows the Administrator to alter the URL definition for each SPS server. Because of this, the DWP Property "MySite" was designed to allow the Administrator to alter the web part in order to support their SPS MySite setup.
Use:<MySite xmlns="webpart_namespace">/sites/<%Domain%> AND/OR <%User%></MySite>
Example: <MySite xmlns="CorasWSC.Document.RollUp">/personal/&lt;%User%&gt;</MySite>
Settings: <%User%> = User Name, <%Domain%> = Domain Name

ReqSearchString (Boolean)

(Optional) Users are permitted to search for specific phrases to return only the information that pertains to them. However, Administrators can deactivate this feature by placing a valid search phrase in the Required Search String field. When this is done, the web part will return the items found via the search phrase. The fields that can be utilized in this search string are identified in the Supported Schemas section of this help, on the “Search Fields” line of each identified schema.

NOTE: If anything is entered in this field, the Search function will be deactivated for general users.

ReturnCount (String)

This parameter allows you to control the maximum number of items that will be displayed on each page of the spreadsheet. A Next/Previous link will be made available if the number of items returned is greater than the number entered here.

ReturnType (String)

This property allows you to specify the function of the web part when searching through lists. "Selective" allows you to select the specific lists that you want to have returned within the web part. When "Selective" is chosen, the "Available Lists" and "Current Lists" select boxes will be activated. "Line of Site" enables the web part to automatically access lists within the site URL and levels chosen. Once "Line of Site" is chosen the "Available Lists" and "Current Lists" fields are deactivated or removed from the display, depending on your version of the Workplace Suite.

SchemaUsed (String)

This property identifies the schemas used to determine the list type, search fields, display fields, and so on. If you select a schema, the elements of that schema will be used to only find those lists that match the schema profile chosen. The configuration of each schema can be found in the “Supported Schemas” section of this help.

SearchAbove1Site (Boolean)

This property allows you to start the collection of list items for roll-up display one level above the site identified in the Site URL field. This applies to Line of Site roll-ups only.

SearchListFieldName (String)

Enter the Field Name of the field that you want to use to populate the search drop-down. The web part will look at all results within the list and return items from that list field, removing any duplicates.

If you identified the "%USER%" parameter in the List Name field above, you can utilize the "email", "loginname", or "username" field. These will allow you to select the email address, login name, or user name of the individuals who have access to the site.

SearchListListName (String)

Enter the "Display Name" of the list you want to return. The "Display Name" is the name displayed in the "Documents and Settings" area of SharePoint. It is not the "URL" name of the list.

SearchListSiteURL (String)

This property is used to define the URL for the site (or the top-level site) you want to access and from which you want to return list items. This can be any SharePoint site that resides on the same server as this web part. If the list exists within the same site as the web part, you do not need to define a URL.

ShowAdmin (Boolean) (3.25- Only)

This property is used to show the Administration window to the administrator, allowing them to manage the sites and lists returned to the web part. This view is only available to administrators of the site or web, or it can be accessed within in a Shared View.

ShowCorasWorks (Boolean)

This Property allows of the hiding and showing the "Powered By CorasWorks" text. By setting this property to true the user will see the "Powered By CorasWorks" text. By setting this property to false the user will not see this text. This property can be changed from true to false or false to true by executing the proper search command.
Use: <ShowCorasWorks xmlns='webpart_namespace'>true/false</ShowCorasWorks>
Example: <ShowCorasWorks xmlns='CorasWSC.Announcement.SpreadSheet.RollUp'>true</ShowCorasWorks>

ShowCreated (Boolean)

Enable this property to return only the items that have been created by the currently logged in user. If this property is used, it will override the Assigned To functionality built into the web part.

ShowEdit (Boolean)

This activates the "Add Item" link and "Edit Item" icon in the web part return. If activated, users will be able to edit and create list items from the web part. If deactivated, users will only be able to view the list item.

ShowHeader (Boolean)

This property controls whether or not field names from the list will be included as headings at the top of the roll-up display. When activated, users will be able to click on the field headings if they want to change the sort order of the display.

ShowItemLink (Boolean)

This property controls whether or not each item included in the web part return includes a hyperlink to the item.  This can be used in conjunction with ShowLinks to remove a user's ability to go directly to a list from within the web part.

ShowLinks (Boolean)

If this parameter is enabled, the site name and list name for each item will be hyperlinked within the display.  If this option is disabled, the site and list names will be displayed without links.

ShowModified (Boolean)

Enable this property to return only the items that have been modified by the currently logged in user. If this property is used, it will override the Assigned To functionality built into the web part.

ShowSearch (Boolean)

The property enables or disables the search bar. While you can disable the search bar via a search command, it cannot be re-enabled via the same method. To re-enable the search, toggle this property.

SiteURL (String)

Enter the URL(s) for the site(s) you want to access and return lists from. This can be any SharePoint site that resides within the Global Configuration Database where this web part resides. Format for the URL must be "http://Site-URL/SiteName". (Examples; "http://www.sitename.com/", "http://www.sitename.com/site1", "http://www.sitename.com/site1/site1a", or "http://www.sitename.com/site 1"). You can also enter multiple URLs separated by a semicolon to access more than one site at a time. There should be no spaces between the URLs and the semicolon. This applies to both "Selective" and "Line of Site."

Target (String)

This property is used to define the target window for the links provided in the web part. For example, if you wanted any links that are clicked on to open in a new window, you would set the property to _new. Other values include _blank, _parent, and _self

ThreadWebPart (Boolean)

This property is used to reset the web part to thread its execution against SharePoint. Enabling this is useful under the following four conditions:

·      Have a multi-processor box

·      Are using this web part for heavy transactions against SQL server. Returning +1000 Items

·      Heavy User Load on this one web part

·      Multiple Worker Processes

Enabling this choice will regulate better the transactions happening on your server improving the overall performance. While the effect of this may not alter the performance of this one web part, the server itself will react much better for other pages. If you are on a multi-processor or multi-worker process server, this can also help with improving performance of the web part as the threads are shared better by each process.

If you are enabling this feature you may be required to update the web.config for your virtual server hosting the site where this web part is being used. The web.config has a line "<WebPartWorkItem Timeout="7000" />". This relates to the amount time given to a thread to collect and present data. If you are collecting large amounts of data this may need to be increased to support this higher load. The 7000 represents 7000 milliseconds. If you wish to allow a thread to execute for longer you must change this to the value you require. (Example 60 Seconds = 60000).

WaitForSearch (Boolean)

This feature allows the web part to return no results until the user completes a search. It can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this allows you to have multiple roll-ups on a page, each pointing a different list with a different schema, and utilizing a form web part or another connected web part as a search mechanism for all roll-ups on that page.

 

Back to Top

Modifiable DWP Properties for Document Libraries XE "DWP Properties:Document Libraries - Spreadsheet Roll-Up "

CorasWorks web parts have a number of properties that can only be modified by manually editing the DWP file associated with this web part. The property described here applies specifically to document libraries. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

These properties allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the 1For DevelopersHelp_D2HPrivate(-9,656)Overview1 help topic.

Also note that some of these properties some may require the use of a "<", ">", or "&" symbol. If that is the case, you will need to replace these characters with their encoded equivalents of "&lt;", "&gt;", and "&amp;" respectively.

These properties are only viewable in the DWP if the default settings have been changed.

NOTE: As of the Summer 05 release of the Workplace Suite, a Localization tab on the administration interface allows you to make many of the localization changes described below. Before you make these changes in the DWP, you may want to review the available settings that can be modified on the Localization tab.

GoDirectlyToItem (Boolean)

This property allows an Administrator to specify whether or not and Item in a document library returned by the web part should be linked to the editform.aspx, or go directly to the document itself.

If you set this property to true, the item link will go directly to the document returned. If you set this property to false, the item link will take the user directly to the edit page for the item. This property only functions for document library types.

Use:
<GoDirectlyToItem xmlns="webpart_namespace">true/false</GoDirectlyToItem>

Example:
<GoDirectlyToItem xmlns= "CorasWSC.My.Document.RollUp">true</GoDirectlyToItem>

ShowIcons (Boolean)

This performance enhancement feature allows the administrator to specify whether or not a document display should include an icon to represent the document type.

If this option is set to true, the user will see a type icon for each document displayed. If this property is set to false, no icon will be included in the return. This property only functions for document library types.

Use: <ShowIcons xmlns="webpart_namespace">true/false</ShowIcons>

Example: <ShowIcons xmlns= "CorasWSC.My.Document.RollUp">true</ShowIcons>

 

Modifiable DWP Properties for Localization XE "Localization via DWP: Spreadsheet Roll-Up "  XE "DWP Properties:Localization - Spreadsheet Roll-Up "  XE "Translation:Spreadsheet Roll-Up"  XE "Language:Spreadsheet Roll-Up"

NOTE: This topic only applies to releases of the Workplace Suite prior to the Summer 2005 release. As of the Summer 2005 release, the Localization tab on the administration interface allows you to make all of the localization changes described below. As a result, Summer 2005 and later releases do not support manual modification of DWP properties for localization.

CorasWorks web parts have a number of properties that can only be modified by manually editing the DWP file associated with this web part. The properties described here relate specifically to localization. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

These properties allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the 2For DevelopersHelp_D2HPrivate(-9,656)Overview2 help topic.

Also note that some of these properties some may require the use of a "<", ">", or "&" symbol. With the exception of the LCIDXML property, you must replace these characters with their encoded equivalents of "&lt;", "&gt;", and "&amp;" respectively.

These properties are only viewable in the DWP if the default settings have been changed.

TypeHeaderName (String)

This property will allow the Administrator to alter the Column Header Name for Type. Type is displayed when the type icons are visible for a document library. This only applies to list of a Document Library Type.

Use: <TypeHeaderName xmlns="webpart_namespace">Type Header Name</TypeHeaderName >

Example: <TypeHeaderName  xmlns= "CorasWSC.Document.RollUp">Tip</TypeHeaderName > < BR>

URLDirName (String)

This property is used to determine the root folder of where a document resides within a list. In order to permit the edit and/or linking to an item, this property is required. Since this list property is language dependant, should a different language be chosen the equivalent (URL Dir Name) must be entered.

Use: <URLDirName xmlns="webpart_namespace">URL Dir Name</URLDirName>

Example: <URLDirName xmlns= "CorasWSC.Document.RollUp">Nome directory URL</URLDirName>

EncodedAbsoluteURL(String)

This property is used to determine the direct location of where a document resides within a list. In order to permit the linking to an item directly, this property is required. Since this list property is language dependant, should a different language be chosen the equivalent (Encoded Absolute URL) must be entered.

Use: <EncodedAbsoluteURL xmlns="webpart_namespace">Encoded Absolute URL</EncodedAbsoluteURL>

Example: <EncodedAbsoluteURL xmlns= "CorasWSC.Document.RollUp">URL assoluto codificato</EncodedAbsoluteURL>

LCIDXML

NOTE: As of the Summer 05 release, localization can be done very easily on the Localization tab of the administration interface. See “Admin: Localization Tab” for details.

This property allows you to localize the user interface. The easiest way to use this property is to follow these steps:

1.  Copy the sample code below into Notepad and make the appropriate translations to the content between each tag.

2.  Replace any double quotes (“) with single quotes (‘). Make sure there aren’t any brackets ([ ]) anywhere in the text. If there are, replace them with parentheses ( ). The XML nodes must appear in the exact order as they are shown below; you can not omit nodes or reorder them. (You can use brackets in other areas of the .dwp, but not in this section. This is because the CDATA expression (added later in these procedures) uses brackets to identify the boundaries of the text to work on.)

3.  Export the web part you want to localize and add this: <LCIDXML xmlns="webpart_namespace"><![CDATA[]]></LCIDXML>  (where ”webpart_namespace” is the web part namespace identified in the 3For DevelopersHelp_D2HPrivate(-9,656)Overview3 help topic. Remember that web part namespaces are case-sensitive.
For example: <LCIDXML  xmlns="CorasWSC.Calendar.RollUp"><![CDATA[]]></LCIDXML>

4.  Copy the modified LCIDXML content from Step 2 and place it after the opening bracket after CDATA.

5.  Save the localized web part and import it into your site. CorasWorks recommends that you use a naming convention that makes it clear which language(s) are supported by the web part.

Sample Code:
<?xml version='1.0' ?>
<CorasWorks>
 <CalendarRollUpAdvanced id='default'>
  <Today>Today</Today>
  <ViewByDay>View by Day</ViewByDay>
  <ViewByWeek>View by Week</ViewByWeek>
  <ViewByMonth>View by Month</ViewByMonth>
  <Search>Search</Search>
  <ReturnType>Return Type:</ReturnType>
  <Administration>Administration</Administration>
  <SiteUrl>Site URL:</SiteUrl>
  <LevelsSearch>Levels Searched:</LevelsSearch>
  <Schemas>Schema(s):</Schemas>
  <AvailableLists>Available List(s):</AvailableLists>
  <CurrentLists>Current List(s):</CurrentLists>
  <CloseAdministration>Close Administration</CloseAdministration>
  <Status>Status:</Status>
  <ReturnSitesList>Return All Sites &amp; Lists</ReturnSitesList>
  <Selective>Selective</Selective>
  <LineofSite>Line of Site</LineofSite>
  <UtilizeAllSChemas>Utilize All Schemas</UtilizeAllSChemas>
  <SaveSelection>Save Selection</SaveSelection>
  <SelectAllSiteLists>Select All Sites &amp; Lists</SelectAllSiteLists>
  <RemoveAllSiteLists>Remove All Site &amp; Lists:</RemoveAllSiteLists>
  <AddList>Add List</AddList>
  <RemoveList>Remove List</RemoveList>
  <SelectSearchCriteria>Select Search Criteria</SelectSearchCriteria>
  <Search>Search</Search>
  <AddItem>Add Item</AddItem>
  <NoItemsFound>NoItems Found - Please check your Lists, Filter, or Search Criteria</NoItemsFound>
  <ExecuteSearch>Please execute a search to see results</ExecuteSearch>
  <ShowAdmin>Show Admin</ShowAdmin>
  <ShowVersion>Show Version</ShowVersion>
  <TimeExceeded>This Process Is Exceeding Its Time Limitations</TimeExceeded>
  <ActionMenu>Actions</ActionMenu>
 </CalendarRollUpAdvanced>
</CorasWorks>

The CorasWorks node supports multiple SpreadsheetRollUpAdvanced nodes, allowing for the same web part to be used on multiple sites. When the web part loads, the language of the site that the web part is hosted in will automatically be used, provided an ID attribute for the site’s SpreadsheetRollUpAdvanced node has been defined, otherwise, the SpreadsheetRollUpAdvanced node with an attribute of 'default' will be used.

To localize the web part for multiple languages, repeat these tags (and the content in between) for each language. However, instead of using ‘default’ after the web part ID, use one of the 4-digit LCIDs provided below. Copy the rest of the LCIDXML text and place it between these tags for each desired language, making the appropriate translations for each language.

The following list shows the LCID for each language.

 XE "Language Codes" LCID Language

1025 Arabic
2052 Chinese - Simplified
1028 Chinese - Traditional
1029 Czech
1030 Danish
1043 Dutch
1033 English
1035 Finnish
1036 French
1031 German
1032 Greek
1037 Hebrew
1038 Hungarian
1040 Italian
1041 Japanese
1042 Korean
1044 Norwegian
1045 Polish
2070 Portuguese
1046 Portuguese – Brazilian
1049 Russian
1034 Spanish
1053 Swedish
1054 Thai
1055 Turkish

 

Search Commands XE "Search Commands:Spreadsheet Roll-Up"  XE "Shortcuts:Spreadsheet Roll-Up"

CorasWorks has built in a few commands so that certain actions can be activated directly from the Search textbox in the Web Part bypassing the need to enter the Web Part Properties Edit window. These commands can be activated by typing the current phrase and then clicking on the search button.

:admin:

This will display the administration interface (Summer 05 and later releases) or the administration window (previous releases) within the web part area, allowing the administrator to define the sites and lists returned to the web part. This option is only available to site collection and/or site/web administrators and in shared view.

:corasworks:

This will hide the “Powered by CorasWorks” text located on the left side of the search bar. To return this text to the display, enter the command again. This option is only available to administrators. Keep in mind that since this command is typed into the search bar, a search on the command text will also be performed, so you will want to refresh the page after executing this command.

:search:

This will hide the search bar from within the web part. If you wish to return the search bar back to the web part display, you will need to manually edit the DWP properties. This option is only available to administrators.

:version:

This will show the version window within the web part area to the user, allowing them to view the application, version, organization, authors, and build date of the web part. The Close Version Window link returns the page back to its original state. No other users will see the version information; the version information is actually displayed on a separate page with “?version=coras” at the end of the URL.

NOTE: Because all CorasWorks web parts utilize this as a means for viewing the version, all CorasWorks web parts on the page will respond when this action is selected. This allows you to identify all web parts created by CorasWorks, with the corresponding information.

[Me]  XE "Search for \"My\" Records:[ME] – Spreadsheet Roll-Up"

This will search throughout all the returned lists for the login name of the individual executing the search. This command does not function for anonymous users.

 

Supported Schemas XE "Schemas:Spreadsheet Roll-Up"  XE "Supported Schemas:Spreadsheet Roll-Up"

Schemas are what allow roll-up web parts to access, understand, and display a list.  They contain all of the elements that identify the list: the list type, the fields to look for, the fields to display and in what order, which fields can be used in a search or a filter, and the percentage of the display that each column should take up.

The following schemas are supported by CorasWorks Roll-Up Advanced (Spreadsheet) web parts out of the box. If you have created your own schemas, they will not be available for selection from this version of the web part; if you want to work with additional schemas and you have either the Developer or Small Business edition of the Workplace Suite, you can use the Roll-Up Wizard to create a modified version of this web part that utilizes the additional schemas.

NOTE: In order for a roll-up to work correctly, each list that is referenced by the roll-up must contain the fields named as “List Template Required Fields” below. Additional fields may be included in the list, but the ones named in each schema below are required.

Announcements (AR0001)

Display Fields: Title (Main Field), Body
Search Fields: Title (Main Field), Body, Expires (DATE)
Filterable Fields: Title, Body, Expires (DATE)
Order By: Title, Body
List Template Type: Announcements
List Template Required Fields: Title (Main Field), Body, Expires (DATE)

Announcements Publish (AR0002)

Display Fields: Title (Main Field), Body
Search Fields: Title (Main Field), Body, Expires (DATE), Publish
Filterable Fields: Title, Body, Expires (DATE), Publish
Order By: Title, Body
List Template Type: Announcements
List Template Required Fields: Title (Main Field), Body, Expires (DATE), Publish

Contacts (CR0001)

Display Fields: Last Name (Main Field), First Name, Company, Email Address, Business Phone,
Search Fields: Last Name (Main Field), First Name, Company, Business Phone, Email Address, City, State, Postal Code
Filterable Fields: Last Name, First Name, Company, Business Phone, Email Address, City, State, Postal Code
Order By: Last Name, First Name, Company
List Template Type: Contacts
List Template Required Fields: Last Name (Main Field), First Name, Company, Email Address, Business Phone, City, State, Postal Code

Contacts Publish (CR0002)

Display Fields: Last Name (Main Field), First Name, Company, Email Address, Business Phone,
Search Fields: Last Name (Main Field), First Name, Company, Business Phone, Email Address, City, State, Postal Code, Publish
Filterable Fields: Last Name, First Name, Company, Business Phone, Email Address, City, State, Postal Code, Publish
Order By: Last Name, First Name, Company
List Template Type: Contacts
List Template Required Fields: Last Name (Main Field), First Name, Company, Email Address, Business Phone, City, State, Postal Code, Publish

CW Co Contacts (CR0003)

Display Fields: Contact, Company (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Company (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description
Filterable Fields: Contact, Company, Job Title, Business Phone, Email Address, City, State, Type, Description
Order By: Contact, Company
List Template Type: Contacts
List Template Required Fields: Contact, Company (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description

CW Co Contacts Publish (CR0004)

Display Fields: Contact, Company (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Company (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description, Publish
Filterable Fields: Contact, Company, Job Title, Business Phone, Email Address, City, State, Type, Description, Publish
Order By: Contact, Company
List Template Type: Contacts
List Template Required Fields: Contact, Company (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description, Publish

CW Org Contacts (CR0005)

Display Fields: Contact, Organization (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Organization (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description
Filterable Fields: Contact, Organization, Job Title, Business Phone, Email Address, City, State, Type, Description
Order By: Contact, Organization
List Template Type: Contacts
List Template Required Fields: Contact, Organization (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description

CW Org Contacts Publish (CR0006)

Display Fields: Contact, Organization (Main Field), Job Title, Email Address, Business Phone
Search Fields: Contact, Organization (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description, Publish
Filterable Fields: Contact, Organization, Job Title, Business Phone, Email Address, City, State, Type, Description, Publish
Order By: Contact, Organization
List Template Type: Contacts
List Template Required Fields: Contact, Organization (Main Field), Job Title, Business Phone, Email Address, City, State, Type, Description, Publish

Documents (DR0001)

Display Fields: Name (Main Field), Title
Search Fields: Name (Main Field), Title
Filterable Fields: Name, Title
Order By: Title, Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title

Documents Publish (DR0002)

Display Fields: Name (Main Field), Title
Search Fields: Name (Main Field), Title, Publish
Filterable Fields: Name, Title, Publish
Order By: Title, Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title, Publish

CW Documents (DR0003)

Display Fields: Name (Main Field), Description, Date Released (DATE), Author
Search Fields: Name (Main Field), Description, Date Released (DATE), Author, Remarks, Document Category, Expiration Date (DATE)
Filterable Fields: Name, Description, Date Released (DATE), Author, Remarks, Document Category, Expiration Date (DATE)
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Description, Date Released (DATE), Author, Remarks, Document Category, Expiration Date (DATE)

CW Documents Publish (DR0004)

Display Fields: Name (Main Field), Description, Date Released (DATE), Author
Search Fields: Name (Main Field), Description, Date Released (DATE), Author, Remarks, Document Category, Expiration Date (DATE), Publish
Filterable Fields: Name, Description, Date Released (DATE), Author, Remarks, Document Category, Expiration Date (DATE), Publish
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Description, Date Released (DATE), Author, Remarks, Document Category, Expiration Date (DATE), Publish

Documents SPS (DR0005)

Display Fields: Name (Main Field), Description
Search Fields: Name (Main Field), Title, Description
Filterable Fields: Name, Title, Description
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title, Description

Documents SPS Publish (DR0006)

Display Fields: Name (Main Field), Description
Search Fields: Name (Main Field), Title, Description, Publish
Filterable Fields: Name, Title, Description, Publish
Order By: Name
List Template Type: DocumentLibrary
List Template Required Fields: Name (Main Field), Title, Description, Publish

Events (ER0001)

Display Fields: Title (Main Field), Begin (DATE), End (DATE)
Search Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description
Filterable Fields: Title, Begin (DATE), End (DATE), Location, Description
Order By: Begin (DATE), End (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description

Events Publish (ER0002)

Display Fields: Title (Main Field), Begin (DATE), End (DATE)
Search Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, Publish
Filterable Fields: Title, Begin (DATE), End (DATE), Location, Description, Publish
Order By: Begin (DATE), End (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Begin (DATE), End (DATE), Location, Description, Publish

STS V1.0 Events (ER0005)

Display Fields: Title (Main Field), Event Date (DATE), End Date (DATE)
Search Fields: Title (Main Field), Event Date (DATE), End Date (DATE), Location, Description
Filterable Fields: Title, Event Date (DATE), End Date (DATE), Location, Description
Order By: Event Date (DATE), End Date (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Event Date (DATE), End Date (DATE), Location, Description

STS V1.0 Events Publish (ER0006)

Display Fields: Title (Main Field), Event Date (DATE), End Date (DATE)
Search Fields: Title (Main Field), Event Date (DATE), End Date (DATE), Location, Description
Filterable Fields: Title, Event Date (DATE), End Date (DATE), Location, Description
Order By: Event Date (DATE), End Date (DATE), Title
List Template Type: Events
List Template Required Fields: Title (Main Field), Event Date (DATE), End Date (DATE), Location, Description, Publish

Links (LR0001)

Display Fields: URL (Main Field), Notes
Search Fields: URL (Main Field), Notes
Filterable Fields: URL, Notes
Order By: URL
List Template Type: Links
List Template Required Fields: URL (Main Field), Notes

Links Publish (LR0002)

Display Fields: URL (Main Field), Notes
Search Fields: URL (Main Field), Notes, Publish
Filterable Fields: URL, Notes, Publish
Order By: URL
List Template Type: Links
List Template Required Fields: URL (Main Field), Notes, Publish

Tasks (TR0001)

Display Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE)
Search Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description
Filterable Fields: Title, Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description
Order By: Title, Status
List Template Type: Tasks
List Template Required Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description

Tasks Publish (TR0002)

Display Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE)
Search Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish
Filterable Fields: Title, Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish
Order By: Title, Status
List Template Type: Tasks
List Template Required Fields: Title (Main Field), Assigned To, Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish

Project Status (TR0003)

Display Fields: Title (Main Field), Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE)
Search Fields: Title (Main Field), Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description
Filterable Fields: Title, Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description
Order By: Title, Project Status
List Template Type: Tasks
List Template Required Fields: Title, Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description

Project Status Publish (TR0004)

Display Fields: Title (Main Field), Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE)
Search Fields: Title (Main Field), Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish
Filterable Fields: Title, Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish
Order By: Title, Project Status
List Template Type: Tasks
List Template Required Fields: Title, Manager, Project Status, Priority, Start Date (DATE), % Complete, Due Date (DATE), Description, Publish

Troubleshooting XE "Troubleshooting:Spreadsheet Roll-Up "  XE "FAQs:Spreadsheet Roll-Up "  XE "Errors:Spreadsheet Roll-Up "

I see the message "Please Execute a Search..." and no items are returned.

This is because the web part in question is set to not show results until a search has been executed. Please enter a searchable text entry into the search box, or choose a search entry from a search list and then press the Search button. Once you have done this, you should see the results displayed or a message stating that no items were found.

I see the message "Requested Result Has Timed Out" and no items are returned.

This is because the web part in question has multi-threading enabled and the current setup of your Web.Config file won't support the amount of time required to return the data from SharePoint. Multi-threading is enabled and disabled on the Other tab (Summer 05 and later releases) or in the Administration Properties section of the web part tool pane (previous releases).

I do not see the same sites that someone else does.

This is because you do not have the same rights as someone else. Only those sites which you have permission to access will be presented to you.

I receive the error "The format of the URL you specified is incorrect."

This means that the URL you entered in the web part’s "Status Properties" field can not be understood. Please go to the Status Properties field and double-check how you specified the URL. The format of the URL must be either http://Site-URL or http://Site-URL/Sub-Site-Name.

I receive the error "The URL you specified was incorrect and the site cannot be found."

This means that the URL you entered in the web part’s Status Properties field can not be understood. Please go to the Status Properties field and double-check how you specified the URL. The format of the URL must be either http://Site-URL or http://Site-URL/Sub-Site-Name.

I receive the error "No Lists Found"

This indicates that no lists have been found for the site and levels chosen. You should make sure that you have access to the sites you would like search and that you have entered a numerical value in the "Levels Returned" text box on the Sites and Lists tab (Summer 05 and later releases) or the administrative window (previous releases).

I receive the error "The List Being Returned XML is incorrectly formatted."

This indicates that manual administration of the shared web part property "Lists Being Returned" was attempted. Please remove and add the web part to the page and then select the lists to be returned again.

I receive the error "No Items Found..."

This indicates one of the following:

·      The search criteria and/or filter criteria is incorrect

·      The user doesn't have access to the list(s) selected

·      The list or site no longer exists

·      There is no data within any of the lists you have searched

To test your search text, try searching for text taken directly from one of your target lists to see if anything is returned. To test your filter criteria, try choosing a different filter field and searching for the same text to see if anything is returned.

If your search continues to yield no results, check that your target lists are populated, that your target lists and sites still exist, and that you have access to them.

I don't see a list that I know exists within the site.

This can occur for a few reasons:
1) The list must have all of the List Template Required Fields within one of the List Templates Supported (see the “Supported Schemas” help topic)
2) The list must have been created utilizing the proper list template.

My roll-up does not include documents in a folder. Why not?

If you want a Spreadsheet roll-up to include documents in multiple levels of folders, you will need to manually define a basic filter. This is because Spreadsheet roll-ups do not include any items in folders when a CAML-based filter is utilized (defined either manually or using the Filter Builder).

How must a list be set up in order to be returned by the web part?

Lists should be created via SharePoint’s default list template, or with a CorasWorks-generated list like Updated Contacts, to be returned within the web part for selection.

Does the list returned have to be named the same as the Web Part (i.e., Document Roll-Up Advanced - Documents)?

No, you can name a list anything you want.  However, you must make sure that your list was created with the proper list template, and contains the proper fields.

The response time seems slow. Does CorasWorks have any suggestions for improvement?

The following suggestions apply to all roll-ups:

·      Do not put more than one roll-up web part on a page. Since roll-ups are processed serially, adding several roll-ups to a page can cause a considerable delay in returning the page to the user, although this depends on the configuration of the web parts.

·      While roll-ups can be set to pull data from an unlimited number of levels, users will experience the best performance if you configure the roll-up to look no more than 6 or 7 levels deep. As the number of levels increases, the number of sites and lists queried also increases exponentially.

·      Limit the number of lists queried.

·      Limit the number of fields returned.

·      If you have no choice but to hit a large number of sites and lists, use CAML to filter the list before the data is returned. Collaborative Application Markup Language (CAML) is an XML-based language used in SharePoint. Pre-filtering performed through CAML reduces the number of list items received by the roll-up. You can build a CAML filter on the Filtering tab of the administration interface.

·      If you still have an issue with response time, you can improve performance by selecting a specific schema. If all schemas are selected, the roll-up has to check all of them; selecting just one schema improves the roll-up’s efficiency.

 

Build Updates XE "Build Updates:Spreadsheet Roll-Up"  XE "Updates:Spreadsheet Roll-Up"  XE "Releases:Spreadsheet Roll-Up"

The following updates have been made to CorasWorks Advanced Spreadsheet Roll-Ups since they were initially introduced.

September 22, 2006

Resolved the following issues:

·      Using the special character “@” in dynamic or static grouping no longer causes an error

·      Searching and use of a data connection with parentheses (e.g., (1) High,
(2) Normal, etc.) are now both allowed

·      Items that have URL-type columns with a URL and a plus sign (+) are now correctly displayed and linked

·      When configured with Wait for Search, roll-up will return data when the user clicks Next to bring back the next set of data, or when the user clicks on a column to change the sort

June 30, 2006

·      Fixed sorting issue. When column names included a space, the sorting area in the administration interface showed double entries for the column choice.

·      Fixed issue with CAML filters and anonymous users.

·      Filter Builder no longer scrambles entries that start with the same letter.

August 15, 2005

·      Added administration interface

·      Added builders: Filter, dynamic grouping, static grouping, localization, site URL

·      Added sorting ability to Display tab

·      Ability to convert basic filter to CAML at run-time

·      Ability to use calculated fields in filter

·      Added several date functions for filtering (CAML only)

January 11, 2005

·      Fixed Search List issue where search list would not always display data.

·      Added LCIDXML property to allow for localization.

December 1, 2004

·      Added ability to control Date Time Format from properties in web part

·      Added support for percentage fields

·      Added support for currency fields

·      Add ability to assign target to all links displayed in web part

·      Added ability to create a pre-collection CAML query

·      Added ability to support “.” in field name

·      Added ability to return, Current Site Username [mei], Site URL [SiteURL], and Site Title [SiteTitle], for search and filter

·      Added ability to auto calculate date fields for filter including;

·      [CurrentYearStart]

·      [CurrentYearEnd]

·      [CurrentWeekStart]

·      [CurrentWeekEnd]

·      [CurrentMonthStart]

·      [CurrentMonthEnd]

·      Added ability to handle https, mailto, and ftp in links returned from link list

·      Added ability to handle https and ftp return in other fields not of URL type

·      Added ability to connect web part to WVA Models for line of site and selective list return

·      Relocated all properties from being available only in Shared Mode to Personal Mode

·      Made the following properties visible not requiring DWP manual editing

·      Dynamic Grouping

·      Dynamic Grouping Properties

·      Stop Light Display (Grouping Filter)

·      Show Search Bar

·      Show URLs as Text Only

·      Added ability to return empty display initially until a search is completed

·      Added ability to connect web part to any other web part that provides a cell of information for searching of collected data

·      Add ability to create a drop list for searches based upon a list in any other site

·      Added ability to multi-thread web parts across application pools or processors

·      Fixed issue with URL encoding of values from RTF body field

·      Fixed issue with Dynamic Grouping and the special character “#”

·      Fixed issue with support for sites with SSL. Sites would not return at https

·      Fixed issue where duplicate lists were returned if level count was greater than the amount of levels available for a second site entered

·      Fixed issue whereby sorting will not function on Field with space in name

·      May 1, 2004

·      Added Action Menu for Show Admin and Show Version

·      Added Line of Site Capability within Admin View

·      Added Ability to go Directly to Item for Document Libraries

·      Added Ability to hide Icons for Document Library

·      Added Ability to Execute Dynamic Grouping with Tree-View Background, Text Color, and Expanded Settings

·      Added Ability to Change Wording for Search, Next/Previous, Type, Encoded Absolute URL and URL Dir Name for Language Support

·      Added Ability to UnLink Item Title

·      Added Commands :admin:, :version:, :corasworks:, :search: to search command box

·      Updated [ME] to support any cases of "me"

·      Updated Order By Encoding to Support Embedded ASC/DESC commands in Schema

·      Changed Administration Interface for Easier Use Including "Close Administration" Button

·      Added support for multiple URL(s) for Site URL within the Administration window (Example url1;url2)

·      January 5, 2004

·      Modified Web Part Properties Developing Three Groups (Administration, Display, and Return)

·      Added capability to handle not operand "<>" for filter

·      Added capability to choose schema and then lists by schema for Administration View

·      Improved Performance in initial list search from Administration View

·      Added Toggle for Site/List Title with/without links

·      Added Ability to Add All or Remove All Sites/Lists from Selection boxes in Administration View

·      Improved performance for maximum return times

·      Added multiple Filter capability

·      Added function for "[ME]"

·      Added property for showing empty lists